产品简介
openapi-ts-request 是一个开发工具,用于从Swagger2、OpenAPI3或Apifox文档自动生成TypeScript/JavaScript类型定义、请求客户端代码、模拟服务等。它解决手动编写接口代码的繁琐问题,适合前端和后端开发者使用,提高开发效率。
核心功能
- 支持Swagger2/OpenAPI3/Apifox文档格式
- 自动生成TypeScript/JavaScript代码和请求客户端
- 支持自定义请求工具和多种客户端如Axios、Fetch
- 提供模拟请求服务和枚举翻译功能
- 支持通过tags过滤代码生成,灵活配置
快速开始
- 安装 openapi-ts-request 到项目开发依赖:npm i openapi-ts-request --save-dev
- 创建配置文件 openapi-ts-request.config.ts,配置API文档路径和输出目录
- 在 package.json 的 scripts 中添加命令:"openapi": "openapi-ts"
- 运行命令生成代码:npm run openapi
界面预览
与其他方案对比
| 对比项 | 本工具 | 同类商业软件 | 在线服务 |
|---|---|---|---|
| 费用 | 开源免费 | 通常收费或含广告 | 可能有订阅或上传限制 |
| 隐私 | 本地运行,数据自持 | 依赖厂商政策 | 需上传数据到服务器 |
| 可定制性 | 源码开放,社区活跃 | 受限于官方功能 | 功能固定 |
适合谁用
- 需要快速生成API客户端代码的前端开发者
- 使用Swagger或OpenAPI规范进行前后端协作的开发团队
- 希望自动化生成TypeScript类型和请求函数的全栈开发者
- 需要模拟API响应进行本地开发的开发者
下载与版本
当前最新版本为 v1.12.8,发布于 2026-06-10。支持 Windows、macOS、Linux。
⚠️ 注意:本项目仅提供源代码下载,不包含可直接运行的安装包(exe/dmg/apk 等。下载后需要自行编译构建才能使用,适合有一定开发经验的用户。如果你不熟悉编译流程,建议寻找同类开箱即用的替代方案。
注意事项
- 本工具仅供学习和研究使用,请遵守相关法律法规。
- 请尊重内容创作者版权,勿将下载内容用于商业或非法传播。
- 项目源码地址:https://github.com/openapi-ui/openapi-ts-request