OpenAPI till TypeScript-konverterare

Konvertera OpenAPI 3.x-dokument till TypeScript-typer direkt i webbläsaren med vanliga openapi-typescript-inställningar.

OpenAPI-dokument
Klistra in ett OpenAPI 3.0- eller 3.1-dokument som JSON eller YAML, importera det från en fil eller hämta det från en CORS-aktiverad URL.
TypeScript-utdata
Genererade TypeScript-typer skapas med en webbläsarsäker openapi-typescript-pipeline och alternativen nedan.
/**
 * 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>;
Genereringsalternativ
Justera de genererade typerna utan att ändra källdokumentet.

Vad är OpenAPI till TypeScript-konverteraren?

OpenAPI till TypeScript-konverteraren omvandlar ett OpenAPI 3.x-dokument till genererade TypeScript-typer direkt i webbläsaren. Det är användbart när du vill ha en snabb typförhandsvisning, en nedladdningsbar deklarationsfil eller ett säkert sätt att testa openapi-typescript-alternativ utan att skicka ditt schema till en server.

När ska den användas?

Använd det här verktyget när du redan har ett OpenAPI-schema i JSON eller YAML och vill ha typade request- och response-modeller för frontendappar, SDK-prototyper eller API-granskningar. Det är särskilt hjälpsamt när du vill jämföra genereringsalternativ innan du sparar utdata i ditt repository.

Innan du genererar

Den här webbläsaromskrivningen stöder paketerade OpenAPI 3.0- och 3.1-dokument. Om ditt schema fortfarande innehåller externa $ref-mål, bunta eller inline:a dem först och generera sedan den slutliga TypeScript-utdata här.