JSON Schema, başka bir belgenin uyması gereken kuralları söyleyen bir JSON belgesidir: türü, hangi özelliklere sahip olduğu, hangilerinin zorunlu olduğu, değerlerinin hangi tür ve biçimleri aldığı, dizelerin ve dizilerin ne kadar uzun olabileceği. Her büyük dildeki doğrulayıcılar bir belgeyi şemaya göre kontrol eder ve her ihlali bildirir.
type, properties, required, items, enum, format ve pattern gibi anahtar kelimeler bir biçimi tarif etmek için birleşir; $ref tanımları yeniden kullanır. OpenAPI 3.1, istek ve yanıt gövdeleri için JSON Schema (draft 2020-12) kullanır; yani bir API tarifi aynı zamanda kendi trafiği için bir doğrulayıcılar kümesidir.
additionalProperties’in varsayılanının false olduğu sanılır. Varsayılan olarak bir şema bahsetmediği özelliklere izin verir; yani beklenmedik alanlarla dolu bir yanıt yine de geçerli sayılır. Katı sözleşme kontrolleri additionalProperties: false demek zorundadır — ya da fazladan alanların yakalanmadığını kabul etmelidir.
Her API’nin OpenAPI belgesi gövdeleri için JSON Schema’lar içerir; Try it out ile aldığınız bir yanıtı kardeş sitenin JSON to JSON Schema üreticisine yapıştırarak doğrudan veriden çıkarılmış bir şema alın.
Tüm sözlük maddeleri · Test teknikleri · 39 mock REST API’nin tamamı
Son güncelleme