OpenAPI til TypeScript-konvertering

Konverter OpenAPI 3.x-dokumenter til TypeScript-typer helt i nettleseren, med vanlige openapi-typescript-innstillinger.

OpenAPI-dokument
Lim inn et OpenAPI 3.0- eller 3.1-dokument i JSON eller YAML, importer det fra en fil, eller hent det fra en CORS-aktivert URL.
TypeScript-utdata
Genererte TypeScript-typer lages med en nettlesersikker openapi-typescript-pipeline og innstillingene nedenfor.
/**
 * 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>;
Genereringsvalg
Juster de genererte typene uten å endre kilde-dokumentet.

Hva er OpenAPI til TypeScript-konvertering?

OpenAPI til TypeScript-konvertering gjør et OpenAPI 3.x-dokument om til genererte TypeScript-typer direkte i nettleseren. Det er nyttig når du vil ha en rask typeforhåndsvisning, en nedlastbar deklarasjonsfil, eller en trygg måte å teste openapi-typescript-valg uten å sende skjemaet til en server.

Når du bør bruke det

Bruk dette verktøyet når du allerede har et OpenAPI-skjema i JSON eller YAML og vil ha typede request- og response-modeller for frontend-apper, SDK-prototyper eller API-gjennomganger. Det er spesielt nyttig når du vil sammenligne genereringsvalg før du committer resultatet til repositoriet.

Før du genererer

Denne nettleserbaserte versjonen støtter sammenslåtte OpenAPI 3.0- og 3.1-dokumenter. Hvis skjemaet fortsatt inneholder eksterne $ref-mål, pakk dem sammen eller inline dem først, og generer deretter den endelige TypeScript-utdataen her.