Conversor de OpenAPI para TypeScript

Converta documentos OpenAPI 3.x em tipos TypeScript totalmente no navegador, com opções comuns de geração do openapi-typescript.

Documento OpenAPI
Cole um documento OpenAPI 3.0 ou 3.1 em JSON ou YAML, importe de um arquivo ou busque a partir de uma URL com CORS habilitado.
Saída TypeScript
Os tipos TypeScript gerados usam um fluxo openapi-typescript seguro para o navegador e as opções abaixo.
/**
 * 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>;
Opções de geração
Ajuste os tipos gerados sem alterar o documento de origem.

O que é o Conversor de OpenAPI para TypeScript?

O Conversor de OpenAPI para TypeScript transforma um documento OpenAPI 3.x em tipos TypeScript gerados diretamente no navegador. Ele é útil quando você quer uma prévia rápida dos tipos, um arquivo de declaração para baixar ou uma forma segura de testar opções do openapi-typescript sem enviar seu schema para um servidor.

Quando Usar

Use esta ferramenta quando você já tiver um schema OpenAPI em JSON ou YAML e quiser modelos tipados de requisição e resposta para apps frontend, protótipos de SDK ou revisão de APIs. Ela é especialmente útil para comparar opções de geração antes de salvar o resultado no repositório.

Antes De Gerar

Esta versão no navegador suporta documentos OpenAPI 3.0 e 3.1 já agrupados. Se o seu schema ainda tiver targets externos de $ref, faça bundle ou inline deles primeiro e então gere aqui a saída final em TypeScript.