JavaScript Class'tan JSON Schema Üretici

JavaScript kodu Girdisi

Editör yükleniyor…

JSON Schema Çıktısı

Ayarlar

Hangi class'ın şema kökü olacağını seçin.

Ayrıştırma tamamen tarayıcınızda çalışır. Kaynağınız sayfadan asla çıkmaz.

JSON Schema üretmek için JavaScript class'larınızı yapıştırın.

ES6 class'lar ve yaygın alan desenleri desteklenir; kısıtları üretimden sonra ayarlayabilirsiniz.

JavaScript class'ları için JSON Schema üretme — adım adım kılavuz

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.

  1. 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.
  2. 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.
  3. 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.
  4. 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.

İlgili JSON Schema ve kod üretim araçları

Şemaları doğrulamak, mock payload üretmek, JSON örneklerini biçimlendirmek ve kod ile sözleşmeleri senkron tutmak için bu araçları kullanın.

Sık Sorulan Sorular

Hangi JavaScript sözdizimi destekleniyor?

Ayrıştırıcı, property'lere sahip ES6 class tanımlarına odaklanır. Daha doğru sonuçlar için alan yapısını ve türleri yorumlarla veya sabit desenlerle belirtin. Tüm işlem tarayıcınızda yerel çalışır.

JavaScript türleri JSON Schema'ya nasıl eşlenir?

Dönüştürücü, mümkün olduğunda varsayılan değerlerden/örneklerden tür çıkarır; bilgi yoksa string'e düşer. Diziler array, nesneler object olur. Daha hassas kısıtlar için üretilen şemayı düzenleyebilirsiniz.

Birden fazla class ekleyebilir miyim?

Evet. Birden fazla class yapıştırın ve birden fazla tanım tespit edilirse ayarlardan kökü seçin. Class kullanmıyorsanız örnek nesneleri de yapıştırabilirsiniz.

Şemaya uygun mock veriyi nasıl alırım?

Şema üretildikten sonra "Mock Veri Üret" düğmesine tıklayarak Mock Üretici'yi şema ön yüklü şekilde açın. Locale, batch size ve isteğe bağlı alan olasılıklarıyla hızlıca test verisi üretin.

JavaScript Class'tan JSON Schema Üretici | JSONSwiss