OpenAPI-zu-TypeScript-Konverter

OpenAPI-3.x-Dokumente direkt im Browser mit gängigen openapi-typescript-Optionen in TypeScript-Typen umwandeln.

OpenAPI-Dokument
Füge ein OpenAPI-3.0- oder 3.1-Dokument als JSON oder YAML ein, importiere es aus einer Datei oder lade es von einer CORS-fähigen URL.
TypeScript-Ausgabe
Generierte TypeScript-Typen werden mit einer browser-sicheren openapi-typescript-Pipeline und den folgenden Optionen erzeugt.
/**
 * This file was auto-generated by openapi-typescript.
 * Do not make direct changes to the file.
 */

export interface paths {
    "/users": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        get: {
            parameters: {
                query?: never;
                header?: never;
                path?: never;
                cookie?: never;
            };
            requestBody?: never;
            responses: {
                /** @description OK */
                200: {
                    headers: {
                        [name: string]: unknown;
                    };
                    content: {
                        "application/json": components["schemas"]["User"][];
                    };
                };
            };
        };
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
}
export type webhooks = Record<string, never>;
export interface components {
    schemas: {
        User: {
            id: string;
            name: string;
            /** @enum {string} */
            role?: "admin" | "editor" | "viewer";
        };
    };
    responses: never;
    parameters: never;
    requestBodies: never;
    headers: never;
    pathItems: never;
}
export type $defs = Record<string, never>;
export type operations = Record<string, never>;
Generierungsoptionen
Passe die generierten Typen an, ohne das Quelldokument zu ändern.

Was ist der OpenAPI-zu-TypeScript-Konverter?

Der OpenAPI-zu-TypeScript-Konverter wandelt ein OpenAPI-3.x-Dokument direkt im Browser in generierte TypeScript-Typen um. Das ist nützlich, wenn du schnell eine Typvorschau, eine herunterladbare Deklarationsdatei oder eine sichere Möglichkeit zum Testen von openapi-typescript-Optionen möchtest, ohne dein Schema an einen Server zu senden.

Wann sollte man ihn verwenden?

Nutze dieses Tool, wenn du bereits ein OpenAPI-Schema in JSON oder YAML hast und typisierte Request- und Response-Modelle für Frontend-Apps, SDK-Prototypen oder API-Reviews brauchst. Besonders hilfreich ist es, wenn du Generierungsoptionen vergleichen willst, bevor du die Ausgabe in dein Repository übernimmst.

Vor dem Generieren

Diese Browser-Neufassung unterstützt gebündelte OpenAPI-3.0- und 3.1-Dokumente. Falls dein Schema noch externe $ref-Ziele enthält, bünde oder inline sie zuerst und generiere dann hier die finale TypeScript-Ausgabe.