OpenAPI til TypeScript
Generér TypeScript-typer fra skemaerne i et OpenAPI 3- eller Swagger 2.0-dokument i YAML eller JSON. Hver post under components.schemas eller definitions i Swagger 2.0 bliver til en eksporteret grænseflade eller typealias, $ref-links mellem dem bliver til typenavne, og nullable-felter får | null.
Ofte stillede spørgsmål
Hvilke dele af dokumentet konverteres?
Skemaerne under components.schemas i OpenAPI 3 og under definitions i Swagger 2.0. Stier, parametre og svar bliver ikke lavet om til typer; referér til de genererede skematyper fra din egen request- og response-kode.
Hvordan bliver skemanavne lavet om til typenavne?
Hver skemanøgle genopbygges i PascalCase, så user-profile bliver til UserProfile. Når to nøgler ville give samme navn, får den anden tilføjet et tal.
Understøttes nullable-felter?
Ja. nullable: true fra OpenAPI 3.0 og x-nullable: true fra Swagger 2.0 tilføjer | null, og OpenAPI 3.1-typearrays som ["string", "null"] bliver til string | null.
Hvad sker der med referencer, som værktøjet ikke kan løse?
En $ref, der peger uden for dokumentet eller på noget andet end et skema under components.schemas eller definitions, bliver til unknown og oplistes i en kommentar øverst i outputtet.
Understøttes YAML?
Ja. Indsæt dokumentet som YAML eller JSON. Anchors og aliases i YAML udvides før konverteringen.
Hvordan kontrollerer jeg dokumentet først?
Brug OpenAPI-validatoren, som angiver strukturelle problemer og ugyldige referencer. Denne konverter læser kun skemaerne og rapporterer ikke andre fejl.