Convertidor de OpenAPI a TypeScript

Convierte documentos OpenAPI 3.x en tipos de TypeScript directamente en tu navegador con las opciones de generación habituales de openapi-typescript.

Documento OpenAPI
Pega un documento OpenAPI 3.0 o 3.1 en JSON o YAML, impórtalo desde un archivo o recupéralo desde una URL con CORS habilitado.
Salida de TypeScript
Los tipos de TypeScript generados se producen con un flujo openapi-typescript seguro para el navegador y las opciones de abajo.
/**
 * 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>;
Opciones de generación
Ajusta los tipos generados sin cambiar el documento fuente.

¿Qué es OpenAPI to TypeScript Converter?

OpenAPI to TypeScript Converter transforma un documento OpenAPI 3.x en tipos de TypeScript generados directamente en tu navegador. Es útil cuando quieres una vista previa rápida de tipos, un archivo de declaración descargable o una forma segura de probar opciones de openapi-typescript sin enviar tu schema a un servidor.

Cuándo usarlo

Usa esta herramienta cuando ya tengas un schema OpenAPI en JSON o YAML y quieras modelos tipados de petición y respuesta para apps frontend, prototipos de SDK o revisiones de API. Es especialmente útil para comparar opciones de generación antes de confirmar la salida en tu repositorio.

Antes de generar

Esta reescritura para navegador admite documentos OpenAPI 3.0 y 3.1 empaquetados. Si tu schema todavía contiene objetivos $ref externos, agrúpalos o intégralos primero y luego genera aquí la salida final de TypeScript.