🔄 OpenAPI转TypeScript类型生成器

// 粘贴OpenAPI/Swagger规范，自动生成TypeScript类型定义

OpenAPI转TypeScript能做什么？

OpenAPI转TypeScript类型生成器是一款面向全栈开发者的在线工具，能够将OpenAPI/Swagger规范自动转换为TypeScript接口和类型定义。省去手动编写API类型的工作，一键生成类型安全的代码，配合fetch/axios实现端到端的类型安全API调用。

核心功能

• 双版本支持：自动识别Swagger v2和OpenAPI v3格式，使用对应解析逻辑
• $ref引用解析：自动展开$ref引用，生成独立的TypeScript接口，处理循环引用
• 枚举类型：OpenAPI的enum字段自动生成TypeScript union类型或enum定义
• 可选字段处理：灵活控制可选字段标记方式（?标记或|undefined）
• 描述注释：保留OpenAPI中的description字段作为JSDoc注释

使用教程

1. 在输入框粘贴OpenAPI JSON/YAML规范，或点击"加载示例"查看演示；2. 选择枚举输出方式和可选字段标记方式；3. 工具自动实时生成TypeScript类型定义；4. 点击"复制代码"将类型定义复制到剪贴板，或下载为.d.ts文件；5. 在TypeScript项目中导入类型定义，配合HTTP库实现类型安全的API调用。

应用场景

场景一：前后端协作

后端提供OpenAPI规范文档，前端用本工具快速生成TypeScript类型，实现请求参数和响应数据的类型安全。

场景二：API客户端生成

基于OpenAPI规范生成完整的TypeScript类型定义，配合代码生成工具构建类型安全的API客户端SDK。

场景三：文档驱动开发

API-first开发流程中，先定义OpenAPI规范，再用本工具生成类型，确保代码与文档始终一致。

扩展知识

OpenAPI（原名Swagger）是REST API的标准化描述规范，目前最新版本是v3.1。OpenAPI规范用YAML/JSON格式定义API的路径、操作、参数、请求体、响应体等信息。TypeScript类型定义（.d.ts）可以为API调用提供编译时类型检查，避免运行时错误。常见的OpenAPI转TypeScript工具还有openapi-typescript、openapi-typescript等CLI工具，本工具提供在线即时转换的便捷方案。