OpenAPI do TypeScript
Vygenerujte typy TypeScript zo schém dokumentu OpenAPI 3 alebo Swagger 2.0 vo formáte YAML alebo JSON. Každá položka v components.schemas alebo definícia v Swagger 2.0 sa zmení na exportované rozhranie alebo alias typu, prepojenia $ref sa zmenia na názvy typov a nullable polia dostanú | null.
Často kladené otázky
Ktoré časti dokumentu sa konvertujú?
Schémy v časti components.schemas v OpenAPI 3 a v časti definitions v Swagger 2.0. Cesty, parametre a odpovede sa na typy nemenia; na vygenerované typy schém odkazujte vo vlastnom kóde požiadaviek a odpovedí.
Ako sa názvy schém menia na názvy typov?
Každý kľúč schémy sa prevedie na PascalCase, takže user-profile sa zmení na UserProfile. Ak by dva kľúče vytvorili rovnaký názov, k druhému sa pridá číslo.
Podporujú sa nullable polia?
Áno. nullable: true z OpenAPI 3.0 a x-nullable: true zo Swagger 2.0 pridajú | null a polia typov OpenAPI 3.1, napríklad ["string", "null"], sa zmenia na string | null.
Čo sa stane s odkazmi, ktoré nástroj nedokáže vyriešiť?
$ref odkazujúci mimo dokumentu alebo na niečo iné než schému v components.schemas či definitions sa zmení na unknown a uvedie sa v komentári na začiatku výstupu.
Podporuje sa YAML?
Áno. Vložte dokument vo formáte YAML alebo JSON. Kotvy a aliasy v YAML sa pred konverziou rozbalia.
Ako najprv skontrolujem dokument?
Použite Validátor OpenAPI, ktorý vypíše štrukturálne problémy a nefunkčné odkazy. Tento konvertor číta iba schémy a ostatné chyby neuvádza.