TypeScript Türlerinden JSON Schema Üretici

TypeScript kodu Girdisi

Editör yükleniyor…

JSON Schema Çıktısı

Ayarlar

Hangi interface/type'ı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 TypeScript türlerinizi yapıştırın.

Interface'ler, type alias'lar, public class alanları, optional/readonly modifier'lar ve union türleri desteklenir.

TypeScript arayüzleri, type'ları ve class'ları için JSON Schema üretme — adım adım kılavuz

Bu çevrimiçi TypeScript interface'ten 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 – TypeScript 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 tür 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 TypeScript sözdizimi destekleniyor?

Public alanlara sahip interface'ler, type alias'lar ve class'lar ayrıştırılır. Optional property'ler, readonly modifier'lar, string-literal key'ler, union türleri, diziler, Record türleri ve nested referanslar desteklenir. Yorumlar ve decorator'lar yok sayılır; böylece projenizden DTO'ları doğrudan yapıştırabilirsiniz.

Tür eşleme nasıl çalışır?

string, number, boolean, bigint, Date gibi ilkel türler uygun formatlarla JSON Schema ilkel türlerine eşlenir. Foo[]/Array<Foo>, Record<string, T> ve dictionary benzeri yapılar array/object olur. null/undefined içeren union türleri alanı otomatik olarak isteğe bağlı yapar.

Interface'lerin yanı sıra class'lar için de kullanılabilir mi?

Evet. Class public alanlar (veya readonly property'ler) ve type annotation'lar içerdiği sürece JSON Schema'ya dönüştürülür. Araç tamamen tarayıcıda çalışır; kod cihazınızdan çıkmaz.

Şemadan mock JSON'u 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, dizi boyutları ve isteğe bağlı alanları ayarlayarak anında örnek payload üretin.

TypeScript Türlerinden JSON Schema Üretici | JSONSwiss