OpenAPI zu TypeScript-Typen
Wandeln Sie ein OpenAPI- oder Swagger-Dokument in TypeScript-Interfaces und -Typen um.
OpenAPI zu TypeScript-Typen
Fügen Sie ein OpenAPI 3- oder Swagger 2-Dokument (JSON oder YAML) ein und dieses Tool erzeugt übereinstimmende TypeScript-Interfaces für jedes Schema in components/schemas, plus einen Typ pro Endpunkt für seine Path- und Query-Parameter, Request Body und Responses. Dies spart den Schritt, API-Typen jedes Mal von Hand zu schreiben, wenn sich die Spezifikation ändert, und hält den Client mit dem synchron, was der Server tatsächlich zurückgibt.
Die Optionen steuern die Form der Ausgabe. Wählen Sie Interface- oder Type-Deklarationen und entscheiden Sie, wie Nullable-Felder dargestellt werden: als optionale Eigenschaft (x?: string) oder als Union mit null (x: string | null). $ref-Verweise können entweder als benannte Typen bestehen bleiben, die auf das entsprechende Interface verweisen, oder inline überall dort expandiert werden, wo sie verwendet werden. Schalten Sie "Path-, Parameter- und Response-Typen erzeugen" aus, um nur die Component-Schemas zu erhalten, oder schalten Sie eine Status-Code-Union ein, um jeden Response-Code zu sehen, den ein Endpunkt zurückgeben kann, als einzelner Typ. Beschreibungen aus der Spezifikation werden zu JSDoc-Kommentaren über jedem Feld, und ein Namensprefix verhindert Kollisionen der generierten Typen mit Ihren eigenen, wenn Sie sie in einen größeren Codebase einfügen.
Der Parser liest Standard-OpenAPI-Konstrukte — Object- und Array-Schemas, Enums, oneOf/anyOf/allOf, nullable, additionalProperties — und folgt lokalen $ref-Pointern im selben Dokument. Endpunkte, die als veraltet gekennzeichnet sind, können vollständig übersprungen werden, und ein Dokument, das nicht wie OpenAPI aussieht (keine components/schemas oder paths Section), erzeugt eine klare Fehlermeldung anstelle einer leeren Ausgabe.
Alles läuft lokal in Ihrem Browser — Ihre API-Spezifikation, die ein nicht veröffentlichtes Produkt oder ein internes System beschreiben kann, wird niemals irgendwohin hochgeladen. Kopieren Sie die generierten Typen, laden Sie sie als .txt-Datei herunter, um sie in eine .ts-Datei einzufügen, oder senden Sie die Ausgabe direkt zurück zur Eingabe, um sie weiter zu verfeinern.