JSON Şema Oluşturucu
Örnek JSON verilerinden bir JSON Şeması oluşturun. Oluşturucu türleri, zorunlu özellikleri, dizi öğesi şemalarını ve date-time, email, uri ve uuid gibi yaygın dize biçimlerini çıkarır; ardından istekleri doğrulamak, bir API belgelemek veya form oluşturmak için kullanabileceğiniz draft 2020-12, 2019-09 ya da draft-07 şemasını yazar.
Sık sorulan sorular
Hangi JSON Şema taslakları destekleniyor?
OpenAPI 3.1'in kullandığı güncel sürüm olan Draft 2020-12, 2019-09 ve birçok eski doğrulayıcı ile aracın hâlâ beklediği draft-07 desteklenir. Seçim, $schema URL değerini belirler; oluşturucunun yazdığı anahtar sözcükler üçünde de aynı anlama gelir.
Zorunlu özellikler nasıl belirlenir?
Bir özellik, ilgili nesnenin her örneğinde varsa required listesine eklenir. Nesne dizilerinde bazı öğelerde bulunmayan bir anahtar required listesine eklenmez. Hiç required listesi içermeyen bir şema oluşturmak için seçeneği kapatın.
Hangi dize biçimleri algılanıyor?
date-time, date, time, email, uri, uuid ve ipv4. Bir biçim yalnızca özelliğin tüm örnek değerleriyle eşleştiğinde eklenir; bu nedenle serbest metin içeren tek bir değer bile özelliğin düz string olarak kalmasına neden olur. Biçim anahtar sözcüklerini istemiyorsanız algılamayı kapatın.
Şema tamsayıları ondalık sayılardan ayırır mı?
Evet. Tüm örnek değerleri tam sayı olan bir özellik integer türünü alır. Bir örnekte bile kesirli kısım varsa tür number olur; bu tür tamsayıları da kabul eder.
Diziler nasıl tanımlanır?
Bir diziye array türü atanır ve tüm öğelerinden oluşturulan bir items şeması eklenir. Dizideki nesneler birleştirilir; böylece items şeması tüm öğelerde bulunan anahtarları listeler, required listesinde ise yalnızca her öğede bulunan anahtarlar yer alır.
Karışık türler olduğunda ne olur?
Bir özellik farklı türlerde basit değerler içerdiğinde (örneğin bir öğede dize, diğerinde null olduğunda), şema bunları tür dizisi olarak listeler; örneğin ["string", "null"]. Nesneler veya diziler başka türlerle karıştığında, oluşturucu her biri için bir şema içeren anyOf kullanır.
additionalProperties veya sınırlar ekleniyor mu?
Hayır. Bir örnek hangi ek anahtarların yasak olduğunu veya gerçek minimum ve maksimum değerlerin ne olduğunu gösteremez. Bu nedenle oluşturucu additionalProperties, minLength, maximum ve benzeri anahtar sözcükleri eklemez. Verilerinizin gerektirdiği yerlerde bunları elle ekleyin.
Sonuçla verileri doğrulayabilir miyim?
Evet. Şemayı ve verilerinizi JSON Şema Doğrulayıcı'ya yapıştırın veya Ajv gibi bir kitaplıkla kullanın. Önce şemayı kontrol edin: şema örneğinizi yansıtır; bu nedenle gerçek verilerde bulunmayabilen veya null olabilen ama örneğinizde olmayan bir alan için küçük bir düzenleme gerekir.
Şemayı OpenAPI'de kullanabilir miyim?
OpenAPI 3.1, JSON Schema 2020-12'yi doğrudan kullanır; bu nedenle $schema satırını kaldırdıktan sonra oluşturulan şemayı components/schemas altına ekleyebilirsiniz. OpenAPI 3.0 daha eski bir alt küme kullanır; bu sürümde type dizilerini nullable ile değiştirin.
Girdi ne kadar büyük olabilir?
JSON için en fazla 1,000,000 karakter; iç içe geçme derinliği 64 seviyeye kadar. Örnek yalnızca bu istek için analiz edilir ve saklanmaz.