OpenAPI 转 TypeScript 生成器

在浏览器中将 OpenAPI 3.x 文档转换为 TypeScript 类型，并提供常见的 openapi-typescript 生成选项。

OpenAPI 文档
粘贴 OpenAPI 3.0 或 3.1 文档的 JSON 或 YAML，或者从文件导入，也可以从启用 CORS 的 URL 获取。
TypeScript 输出
生成的 TypeScript 类型通过浏览器安全的 openapi-typescript 流程和下面的选项生成。
/**
 * 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>;
生成选项
在不修改源文档的情况下调整生成的类型。

什么是 OpenAPI 转 TypeScript 生成器？

OpenAPI 转 TypeScript 生成器会直接在浏览器中把 OpenAPI 3.x 文档转换为生成的 TypeScript 类型。它适合需要快速预览类型、下载声明文件，或者在不把 schema 发送到服务器的情况下安全测试 openapi-typescript 选项的场景。

何时使用

当你已经有 JSON 或 YAML 格式的 OpenAPI schema，并且希望为前端应用、SDK 原型或 API 评审生成带类型的请求和响应模型时，可以使用这个工具。在提交输出到仓库之前比较不同生成选项时，它尤其有用。

生成前

这个浏览器重写版本支持已打包的 OpenAPI 3.0 和 3.1 文档。如果你的 schema 里仍然包含外部 $ref 目标，请先将它们打包或内联，然后再在这里生成最终的 TypeScript 输出。