Bu çevrimiçi JavaScript class'tan JSON Schema dönüştürücü; gerçek modellerden (DTO, struct, class) JSON Schema üretmenize yardımcı olur. Böylece payload'ları doğrulayabilir, sözleşmeleri paylaşabilir ve mock JSON üretebilirsiniz.
Adım 1 – JavaScript kaynağınızı yapıştırın
- Belgelemek istediğiniz modelleri sol editöre yapıştırın.
- Şemanın definitions üretebilmesi için referans verilen türleri aynı snippet'e dahil edin.
- Örnek yüklemek ve beklenen giriş formatını görmek için Örnek düğmesini kullanın.
Adım 2 – Kök class seçin (gerekirse)
- Birden fazla tanım algılanırsa, API payload'unuzla eşleşen kökü seçin.
- Çıktı şema, seçilen köke göre oluşturulur ve referans türler için ek definitions içerebilir.
Adım 3 – JSON Schema çıktısını inceleyin
- Türleri, required/optional alanları ve iç içe nesne/dizi yapılarını kontrol edin.
- Şunlara dikkat edin:
definitions ve $ref modelleriniz diğer modelleri referansladığında. - Doğrulama, dokümantasyon veya şema-önce geliştirme için şemayı kopyalayın veya indirin.
Adım 4 – Doğrulayın veya mock JSON üretin
- Tıklayın Mock Veri Üret ve şema ön yüklü şekilde mock üreticiyi açın.
- Kırılma yaratan değişiklikleri erken yakalamak için gerçek payload'ları şemanıza göre doğrulayın.
- Gelişmiş şema bileşimine (örn.
anyOf/oneOf/allOf) dayanıyorsanız sonucu Ajv gibi tam bir doğrulayıcıyla doğrulayın.
Şema anahtar kelime desteği notu
Üretilen şemalar $ref içerebilir ve ayrıca anyOf, oneOf, veya allOf. Karmaşık şemalar için tam bir JSON Schema doğrulayıcı kullanın ve gerekirse mock üretiminden önce dereference edin.