Convertitore da OpenAPI a TypeScript

Converti documenti OpenAPI 3.x in tipi TypeScript direttamente nel browser con le opzioni comuni di generazione di openapi-typescript.

Documento OpenAPI
Incolla un documento OpenAPI 3.0 o 3.1 in JSON o YAML, importalo da un file o recuperalo da un URL con CORS abilitato.
Output TypeScript
I tipi TypeScript generati vengono prodotti con una pipeline openapi-typescript sicura per il browser e con le opzioni qui sotto.
/**
 * 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>;
Opzioni di generazione
Regola i tipi generati senza modificare il documento sorgente.

Cos’è OpenAPI To TypeScript Converter?

OpenAPI to TypeScript Converter trasforma un documento OpenAPI 3.x in tipi TypeScript generati direttamente nel browser. È utile quando vuoi un’anteprima rapida dei tipi, un file di dichiarazione scaricabile o un modo sicuro per provare le opzioni di openapi-typescript senza inviare lo schema a un server.

Quando Usarlo

Usa questo strumento quando hai già uno schema OpenAPI in JSON o YAML e vuoi modelli tipizzati di richieste e risposte per app frontend, prototipi di SDK o revisioni delle API. È particolarmente utile per confrontare le opzioni di generazione prima di salvare l’output nel repository.

Prima Di Generare

Questa riscrittura nel browser supporta documenti OpenAPI 3.0 e 3.1 raggruppati. Se lo schema contiene ancora target $ref esterni, raggruppali o incorporali prima, poi genera qui l’output TypeScript finale.