JSON Swiss

JSON Swiss

Ruby Class'tan JSON Schema Üretici

Ruby kodu Girdisi

Editör yükleniyor…

JSON Schema Çıktısı

Ayarlar

Hangi class'ın JSON Schema 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 Ruby class'larınızı yapıştırın.

attr_accessor/attr_reader bildirimleri, nested class'lar ve yok sayılan metotlar desteklenir.

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

Bu çevrimiçi Ruby 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 – Ruby 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.

JSON Schema Mock Veri Üretici

Test, fixture ve dokümantasyon için şemanızdan örnek JSON üretin.

JSON Schema Doğrulayıcı

JSON'u yaygın şema anahtar kelimelerine göre doğrulayın ve uyumsuzlukları hızlıca bulun.

JSON'dan Ruby Sınıflarına

JSON örneklerinden Ruby türleri ve modelleri üretin.

JSON'dan JSON Schema Üretici

Model-önce şemaları tamamlamak için temsil edici JSON örneklerinden şema üretin.

JSON Schema Kütüphanesi

Nesneler, diziler, enum'lar ve kısıtlar için şema örneklerini ve desenlerini keşfedin.

JSON Biçimlendirici

Şemaya göre doğrulamadan veya dokümantasyonu paylaşmadan önce JSON örneklerini temizleyin.

Sık Sorulan Sorular

Hangi Ruby yapıları destekleniyor?

Ayrıştırıcı, attr_reader/attr_accessor bildirimleriyle attribute'ları dışa açan class'lara odaklanır. Her attribute bir JSON Schema property'si olur. Metotlar ve diğer Ruby kodları yok sayılır; bu yüzden sade model class'larını güvenle yapıştırabilirsiniz.

Attribute'lar nasıl tiplenir?

Ruby dinamik olduğu için attribute'lar şemada varsayılan olarak `string` olur. Literal varsayılanlar vererek türleri iyileştirebilirsiniz; ileride type yorumlarını okuyan güncellemeler gelebilir. Şimdilik bu araç DTO'lar için hızlı bir yapısal şema sağlar.

Neden bu aracı kullanmalıyım?

Ruby domain nesnelerini veya ActiveModel benzeri DTO'ları diğer ekiplerle paylaşırken JSON Schema; payload'ları belgelemeye ve sözleşmeleri doğrulamaya yardımcı olur. Bu dönüştürücü tamamen tarayıcıda çalışır.

Mock JSON payload'larını 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 ve anında örnek payload'lar oluşturun.

Ruby Class'tan JSON Schema Üretici | JSONSwiss