OpenAPI do TypeScript
Generuj typy TypeScript ze schematów dokumentu OpenAPI 3 lub Swagger 2.0 w YAML lub JSON. Każdy wpis w sekcji components.schemas lub w definitions w Swagger 2.0 staje się eksportowanym interfejsem albo aliasem typu; odwołania $ref między nimi stają się nazwami typów, a pola nullable otrzymują | null.
Najczęściej zadawane pytania
Które części dokumentu są konwertowane?
Schematy w sekcji components.schemas w OpenAPI 3 oraz w definitions w Swagger 2.0. Ścieżki, parametry i odpowiedzi nie są przekształcane w typy; odwołuj się do wygenerowanych typów schematów w swoim kodzie żądań i odpowiedzi.
Jak nazwy schematów są przekształcane w nazwy typów?
Każdy klucz schematu jest przekształcany do PascalCase, więc user-profile staje się UserProfile. Gdy dwa klucze dałyby tę samą nazwę, do drugiego dodawana jest liczba.
Czy pola nullable są obsługiwane?
Tak. nullable: true z OpenAPI 3.0 i x-nullable: true ze Swagger 2.0 dodają | null, a tablice typów OpenAPI 3.1, takie jak ["string", "null"], stają się string | null.
Co się dzieje z odwołaniami, których narzędzie nie potrafi rozwiązać?
$ref wskazujące poza dokument lub na element inny niż schemat w components.schemas albo definitions staje się unknown i jest wymieniane w komentarzu na początku wyniku.
Czy obsługiwany jest YAML?
Tak. Wklej dokument jako YAML lub JSON. Kotwice i aliasy w YAML są rozwijane przed konwersją.
Jak najpierw sprawdzić dokument?
Użyj walidatora OpenAPI, który podaje problemy strukturalne i błędne odwołania. Ten konwerter odczytuje tylko schematy i nie zgłasza innych błędów.