Swagger 2.0 Doğrulayıcı

2.0 için geçmenin neyi kapsadığı

2.0 dosyası için sürüm kontrolü, üst düzeyde bir swagger anahtarı ile karşılanır. Araç değerinin "2.0" olup olmadığını doğrulamaz, bu yüzden yanlış bir numarayı yakalamaz. Sürümün ötesinde info.title, info.version ve bir paths nesnesi gerekir.

host, basePath, schemes, definitions ve securityDefinitions gibi Swagger 2.0’a özgü alanlar incelenmez. Eksik bir host ya da bozuk bir definitions bloku bildirilmez.

Çalışılmış bir örnek

{
  "swagger": "2.0",
  "info": { "title": "Shop API", "version": "1.0" },
  "paths": {
    "/products": {
      "get": { "summary": "List products" },
      "x-internal": true
    }
  }
}

Sürüm alanı, info ve paths hepsi mevcut, bu yüzden hata yok. Rapor bir uyarı gösterir:

Uyarılar geçerliliği engellemediği için belge yine de geçerli bildirilir. x-internal gibi satıcı uzantısı anahtarları Swagger 2.0’da yasaldır, bu yüzden olduğu gibi bırakabilirsiniz.

2.0’dan geçiş

OpenAPI 3.x’e geçmeyi planlıyorsanız dönüştürülmüş dosyayı aynı kutuya yapıştırıp sonuçları karşılaştırabilirsiniz. Kontrol aynıdır; yalnızca openapi alanı swagger alanının yerini alır. Gerçek geçiş işi için tam bir dönüştürücü ve linter çalıştırın, çünkü bu araç definitions veya host ayarlarını çevirmez.

Hızlı bir kontrolün yeterli olduğu durumlar

Swagger 2.0 tanımları yıllarca depolarda yaşar ve elle düzenlenir. Birini devraldığınızda, bir araç yüklemeyi reddettiğinde ve eksik bir alandan şüphelendiğinizde ya da iki dosyayı birleştirip sonucun hâlâ info ve paths bölümlerine sahip olduğundan emin olmak istediğinizde hızlı bir yapısal kontrol faydalıdır. definitions ve güvenlik ayarları dahil tam 2.0 kuralları için özel bir linter ile devam edin.

Temiz bir raporun yalnızca yapı hakkında bir beyan olduğunu unutmayın. Yanıtsız işlemler, yanlış parametre türleri ve çözülmemiş referanslar bu kontrolün dışındadır; bu yüzden dosyayı belge veya kod üretme aracınızda da test edin.