OpenAPI'den TypeScript'a
YAML veya JSON biçimindeki OpenAPI 3 ya da Swagger 2.0 belgesinin şemalarından TypeScript türleri oluşturun. components.schemas altındaki her girdi veya Swagger 2.0'daki definitions, dışa aktarılan bir arayüze ya da tür takma adına dönüşür; aralarındaki $ref bağlantıları tür adlarına dönüşür ve null olabilir alanlara | null eklenir.
Sık sorulan sorular
Belgenin hangi bölümleri dönüştürülür?
OpenAPI 3'te components.schemas altındaki, Swagger 2.0'da ise definitions altındaki şemalar dönüştürülür. Yollar, parametreler ve yanıtlar türlere dönüştürülmez; oluşturulan şema türlerini kendi istek ve yanıt kodunuzda kullanın.
Şema adları tür adlarına nasıl dönüştürülür?
Her şema anahtarı PascalCase biçiminde yeniden oluşturulur; böylece user-profile, UserProfile olur. İki anahtar aynı adı oluşturacaksa ikincisinin sonuna bir sayı eklenir.
Null olabilir alanlar destekleniyor mu?
Evet. OpenAPI 3.0'daki nullable: true ve Swagger 2.0'daki x-nullable: true, | null ekler; ["string", "null"] gibi OpenAPI 3.1 tür dizileri string | null olur.
Aracın çözemediği başvurulara ne olur?
Belge dışındaki bir öğeyi veya components.schemas ya da definitions içindeki bir şema dışındaki bir şeyi gösteren $ref, unknown olur ve çıktının başındaki bir yorumda listelenir.
YAML destekleniyor mu?
Evet. Belgeyi YAML veya JSON biçiminde yapıştırın. YAML içindeki çapalar ve takma adlar dönüştürme öncesinde genişletilir.
Belgeyi önce nasıl denetleyebilirim?
Yapısal sorunları ve bozuk başvuruları listeleyen OpenAPI Doğrulayıcısı'nı kullanın. Bu dönüştürücü yalnızca şemaları okur ve diğer hataları raporlamaz.