OpenAPI YAML Doğrulayıcı

Girintilerin sonucu neden etkilediği

YAML’da anahtarların iç içe geçme düzeyi, bir alanın hangi nesneye ait olduğunu belirler. version alanı, bir seviye aşağıda değil de info ile aynı girintide duruyorsa belge yine okunabilir YAML’dır, ancak info.version eksik kalır ve kontrol bunu bildirir. paths için de aynısı geçerlidir: bir yol anahtarı yanlışlıkla info altında girintilenirse üst düzeydeki paths nesnesi kaybolur.

Boşluk kullanın, sekme kullanmayın ve her seviye için tutarlı bir adım, örneğin seviye başına iki boşluk, tutturun.

Çalışılmış bir örnek

openapi: 3.0.3
info:
  title: Pets API
paths:
  /pets:
    get:
      summary: List pets

Sürüm alanı, info.title ve paths mevcut; /pets eğik çizgiyle başlıyor ve get bilinen bir metot. Eksik olan tek şey info.version. Rapor şunu listeler:

info altına iki boşlukla girintili version: 1.0.0 ekleyin; belge yapısal olarak geçerli bildirilir.

Okuma güvenilir olsun diye belgeleri sade tutun

Kontrol, tutarlı girintilerle iç içe geçmiş düz anahtar: değer satırları gibi sıradan YAML eşlemelerini en iyi şekilde okur. Çapa veya çok satırlı bloklar gibi gelişmiş YAML özelliklerine sahip bir belge okunamaz bildirilir ya da alanlar eksik görünürse, sorunun içerikte mi yoksa YAML sözdiziminde mi olduğunu anlamak için aynı spesifikasyonun bir JSON kopyasını deneyin.

Temiz bir sonuç yalnızca iskeleti onaylar. $ref bağlantılarını çözmez ve şemaları kontrol etmez.

YAML spesifikasyonları için pratik bir iş akışı

Küçük adımlarla düzenleyin ve sık sık yeniden kontrol edin. Yeni bir yol eklediğinizde veya bir bloğu taşıdığınızda, değişiklik tazeyken hatalı bir girintinin yakalanması için dosyayı yeniden yapıştırın. Büyük bir spesifikasyonu birden fazla dosyaya böldüğünüzde birleştirilmiş sürümü yapıştırın, çünkü bu kontrol yalnızca size verilen metni okur ve diğer dosyaları yüklemez. Web sayfalarının boşlukları ve tırnakları YAML’ın okunuşunu değiştiren benzer görünümlü karakterlerle değiştirebileceği için, işlenmiş bir sayfa yerine düzenleyicinizden kopyalayın.

Son olarak, raporun yalnızca kontrolün görebildiklerini listelediğini unutmayın. Bir YAML dosyasında temiz sonuç, iskeletin doğru olduğu anlamına gelir; içindeki her işlemin, şemanın veya referansın doğru olduğu anlamına gelmez.