JSON Schema Üretici

Bu araç ne işe yarar?

JSON Schema Generator, örnek bir JSON belgesinden onu doğrulayan bir JSON Schema üretir. API'lerini belgelemek, gelen veriyi doğrulamak veya sözleşme testi yazmak isteyen geliştiriciler için elle şema yazma zahmetini ortadan kaldırır; draft-07, 2019-09 ve 2020-12 sürümlerini destekler.

Nasıl kullanılır?

Yapılandırma bilgilerinizi girin.
Aracın ürettiği çıktıyı inceleyin.
Hazır kodu/dosyayı kopyalayın.

Tiplerin ve yapının çıkarılması

Araç verini gezerek her alan için type değerini belirler: tam sayılar integer, ondalıklılar number, true/false boolean, metinler string olur. Nesneler için bir properties bloğu oluşturulur ve additionalProperties: false eklenerek beklenmeyen alanlar reddedilir. Diziler için items, ilk öğeden çıkarılan şemayla tanımlanır; boş diziler herhangi bir öğeye izin verir. Bu sayede tek bir örnek JSON'dan başlanarak çalışan bir doğrulama şeması elde edilir.

Zorunlu alanlar ve taslak sürümü

'Tüm alanları zorunlu işaretle' seçeneği açıkken her nesnenin tüm anahtarları required dizisine eklenir; böylece şema, tüm alanların var olmasını dayatır. İsteğe bağlı alanların olduğu durumlarda bu seçeneği kapatıp üretilen şemayı elle düzenleyebilirsin. Üç taslak sürümü arasından seçim yapabilirsin: bu yalnızca $schema URI'sini ve sözdizimi sözleşmelerini etkiler, çıkarılan yapı aynı kalır.

Sıkça sorulan sorular

Hangi JSON Schema taslaklarını destekliyor?

draft-07, 2019-09 ve 2020-12. Seçimin yalnızca çıktının $schema URI'sini değiştirir; alan tipleri ve yapı tüm sürümlerde aynı şekilde çıkarılır.

additionalProperties neden false olarak ekleniyor?

Şemanın katı olması için: tanımlanmamış ekstra alanlar reddedilir. Ek alanlara izin vermek istiyorsan üretilen şemada bu satırı kaldırabilir veya true yapabilirsin.

Çıkarılan şema her durumu kapsar mı?

Şema, verdiğin örneğe dayanır; format, minimum/maksimum veya enum gibi kısıtlar otomatik eklenmez. Bunları çıktıya kendin ekleyerek doğrulamayı güçlendirebilirsin.