OpenAPI 转 TypeScript

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

OpenAPI 文档

粘贴 OpenAPI 3.0 或 3.1 文档的 JSON 或 YAML,或者从文件导入,也可以从启用 CORS 的 URL 获取

TypeScript 输出

使用 openapi-typescript 和当前选项生成 TypeScript 类型

生成选项

在不修改源文档的情况下调整生成的类型

什么是 OpenAPI 转 TypeScript 生成器?

直接在浏览器中将 OpenAPI 3.x 文档转换为 TypeScript 类型。可快速预览类型、下载声明文件,或比较 `openapi-typescript` 的生成选项,无需将文档发送到服务器。

何时使用

已有 JSON 或 YAML 格式的 OpenAPI 文档,需要为前端应用、SDK 原型或 API 评审生成请求和响应类型时,可以使用本工具。也可在提交到仓库前,先比较不同生成选项的结果。

生成前

本工具支持已打包的 OpenAPI 3.0 和 3.1 文档。如果文档中包含外部 `$ref` 引用,请先打包或内联这些引用,再生成 TypeScript 类型。

使用方法

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