OpenAPI zu TypeScript
Erzeuge TypeScript-Typen aus den Schemas eines OpenAPI-3- oder Swagger-2.0-Dokuments in YAML oder JSON. Jeder Eintrag unter components.schemas oder definitions in Swagger 2.0 wird zu einem exportierten Interface oder Typalias. $ref-Verweise zwischen ihnen werden zu Typnamen, und nullable Felder erhalten | null.
Häufig gestellte Fragen
Welche Teile des Dokuments werden umgewandelt?
Die Schemas unter components.schemas in OpenAPI 3 und unter definitions in Swagger 2.0. Pfade, Parameter und Antworten werden nicht in Typen umgewandelt. Du kannst in deinem eigenen Request- und Antwortcode auf die generierten Schema-Typen verweisen.
Wie werden Schemanamen in Typnamen umgewandelt?
Jeder Schema-Schlüssel wird in PascalCase umgewandelt, sodass aus user-profile UserProfile wird. Wenn zwei Schlüssel denselben Namen ergeben würden, wird an den zweiten eine Zahl angehängt.
Werden nullable Felder unterstützt?
Ja. nullable: true aus OpenAPI 3.0 und x-nullable: true aus Swagger 2.0 fügen | null hinzu. OpenAPI-3.1-Typarrays wie ["string", "null"] werden zu string | null.
Was passiert mit Referenzen, die das Tool nicht auflösen kann?
Ein $ref, das außerhalb des Dokuments oder auf etwas anderes als ein Schema in components.schemas oder definitions verweist, wird zu unknown und in einem Kommentar am Anfang der Ausgabe aufgeführt.
Wird YAML unterstützt?
Ja. Füge das Dokument als YAML oder JSON ein. Anker und Aliase in YAML werden vor der Umwandlung erweitert.
Wie prüfe ich das Dokument zuerst?
Verwende den OpenAPI-Validator. Er listet Strukturprobleme und ungültige Referenzen auf. Dieser Konverter liest nur die Schemas und meldet keine anderen Fehler.