OpenAPI do TypeScript
Vygenerujte typy TypeScript ze schémat dokumentu OpenAPI 3 nebo Swagger 2.0 ve formátu YAML nebo JSON. Každá položka v components.schemas nebo definice ve Swagger 2.0 se změní na exportované rozhraní nebo alias typu, odkazy $ref mezi nimi se změní na názvy typů a nullable pole dostanou | null.
Často kladené otázky
Které části dokumentu se převádějí?
Schémata v části components.schemas v OpenAPI 3 a v části definitions ve Swagger 2.0. Cesty, parametry a odpovědi se na typy nepřevádějí; na vygenerované typy schémat odkazujte ve vlastním kódu požadavků a odpovědí.
Jak se názvy schémat mění na názvy typů?
Každý klíč schématu se převede na PascalCase, takže user-profile se změní na UserProfile. Pokud by dva klíče vytvořily stejný název, druhý dostane na konec číslo.
Jsou podporována nullable pole?
Ano. nullable: true z OpenAPI 3.0 a x-nullable: true ze Swagger 2.0 přidají | null a pole typů OpenAPI 3.1, například ["string", "null"], se změní na string | null.
Co se stane s odkazy, které nástroj nedokáže vyřešit?
Odkaz $ref mimo dokument nebo na něco jiného než schéma v components.schemas či definitions se změní na unknown a uvede se v komentáři v horní části výstupu.
Je podporováno YAML?
Ano. Vložte dokument jako YAML nebo JSON. Kotvy a aliasy v YAML se před převodem rozbalí.
Jak mám dokument nejprve zkontrolovat?
Použijte validátor OpenAPI, který vypíše strukturální problémy a neplatné odkazy. Tento převodník pouze čte schémata a ostatní chyby nehlásí.