OpenAPI naar TypeScript
Genereer TypeScript-typen uit de schema's van een OpenAPI 3- of Swagger 2.0-document in YAML of JSON. Elke vermelding onder components.schemas, of elke definitie in Swagger 2.0, wordt een geëxporteerde interface of typealias; koppelingen via $ref worden typenamen en nullable-velden krijgen | null.
Veelgestelde vragen
Welke delen van het document worden omgezet?
De schema's onder components.schemas in OpenAPI 3 en onder definitions in Swagger 2.0. Paths, parameters en responses worden niet omgezet naar typen; verwijs vanuit je eigen request- en responsecode naar de gegenereerde schematypen.
Hoe worden schemanamen omgezet naar typenamen?
Elke schemasleutel wordt omgezet naar PascalCase; user-profile wordt dus UserProfile. Als twee sleutels dezelfde naam zouden opleveren, krijgt de tweede er een getal achter.
Worden nullable-velden ondersteund?
Ja. nullable: true uit OpenAPI 3.0 en x-nullable: true uit Swagger 2.0 voegen | null toe. Type-arrays van OpenAPI 3.1, zoals ["string", "null"], worden string | null.
Wat gebeurt er met verwijzingen die de tool niet kan oplossen?
Een $ref die buiten het document verwijst of naar iets anders dan een schema in components.schemas of definitions, wordt unknown en wordt vermeld in een commentaar bovenaan de uitvoer.
Wordt YAML ondersteund?
Ja. Plak het document als YAML of JSON. Anchors en aliases in YAML worden vóór de conversie uitgebreid.
Hoe controleer ik het document eerst?
Gebruik de OpenAPI Validator, die structurele problemen en ongeldige verwijzingen vermeldt. Deze converter leest alleen de schema's en rapporteert geen andere fouten.