JSON Şeması'ndan TypeScript türlerine
Bir JSON Şeması'nı TypeScript türlerine dönüştürün. Nesneler, zorunlu ve isteğe bağlı özellikleri olan arayüzlere dönüşür; $defs ve tanımlar, $ref'ın işaret ettiği adlandırılmış dışa aktarımlara dönüşür. enum ve const sabit türlere, anyOf ve oneOf birleşim türlerine, allOf ise kesişim türüne dönüşür. Açıklamalar belge yorumları olarak korunur.
Sık sorulan sorular
Hangi JSON Şema taslakları destekleniyor?
Dönüştürücü, draft-07, 2019-09 ve 2020-12 tarafından paylaşılan şu anahtar sözcükleri okur: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf ve $ref ile $defs ya da definitions. minLength veya pattern gibi doğrulama anahtar sözcüklerinin TypeScript karşılığı yoktur ve çıktıya alınmaz.
$ref başvuruları nasıl çözümlenir?
#, #/$defs/Name ve #/definitions/Name başvuruları, ilgili tanımın adlandırılmış türüne dönüşür. Başka bir dosyaya veya URL'e yapılan başvuru gibi diğer tüm başvurular unknown olarak türlenir ve çıktının başındaki bir yorumda listelenir.
additionalProperties nasıl ele alınır?
Hiçbir özelliği olmayan ve additionalProperties şeması bulunan bir nesne Record<string, T> olur. Özellikleri ve additionalProperties şeması olan bir nesne, arayüzün Record<string, T> ile birleştirilmiş hâline dönüşür. additionalProperties false veya eksik bir anahtar sözcük hiçbir şey eklemez; çünkü TypeScript nesne türleri bilinen anahtarları zaten tanımlar.
nullable ne işe yarar?
OpenAPI 3.0'daki nullable: true anahtar sözcüğü ve Swagger x-nullable uzantısı, türe | null ekler. JSON Şeması'nın kendisinde type: ["string", "null"] yazın; bu, string | null olur.
Özyinelemeli şemalar destekleniyor mu?
Evet. Kendisini veya başka bir tanımı $ref üzerinden referans alan bir tanım, diğer adı işaret eden adlandırılmış bir türe dönüşür ve TypeScript bunu sorunsuz çözümler.
Şemamın geçerli olup olmadığını denetliyor mu?
Yalnızca şemayı okur. Bilinmeyen anahtar sözcükler yok sayılır ve türü olmayan bir şema unknown olur. Verileri bir şemaya göre denetlemek için JSON Şema Doğrulayıcısı'nı kullanın.