产品简介
openapi-ui 基于OpenAPI/Swagger规范构建的接口文档工具，核心功能是让开发者能直接在文档页面模拟参数并调试API接口。它简化了传统Postman工具的复杂流程，适合需要频繁查看和测试API的前后端开发者。
核心功能
- 支持快速生成Mock请求参数并调用API
- 兼容Swagger2.0和OpenAPI3.0规范（json/yml格式）
- 支持配置全局请求超时和授权信息
- 支持通过URL、上传文件或文本导入API规范
- 支持Docker部署与环境变量配置
快速开始
- 确保Node.js版本不低于18，使用pnpm或npm安装项目依赖。
- 获取项目源码，进入项目目录。
- 执行`npm run dev`或`make dev`命令启动开发服务器。
界面预览
与其他方案对比
| 对比项 | openapi-ui | 同类方案 |
|---|---|---|
| 工具定位 | 文档查看与接口调试一体化，在文档页面内直接调试。 | 典型的Postman等工具需在独立的请求构建界面操作，与文档分离。 |
| 参数准备 | 根据API Schema自动生成Mock请求参数。 | 通常需要用户手动填写或通过脚本生成测试数据。 |
| 使用门槛 | 基于Web，通过CDN或npm包即可集成，更轻量。 | 通常是独立桌面应用或需要复杂配置的Web应用。 |
适合谁用
- 需要根据OpenAPI/Swagger文档调试接口的前端开发人员
- 需要快速测试后端API接口可用性的后端开发人员
- 需要基于API文档进行测试验证的测试工程师
下载与版本
当前最新版本为 v2.3.3，发布于 2024-10-13。支持 Windows、macOS、Linux。
⚠️ 注意：本项目仅提供源代码下载，不包含可直接运行的安装包（exe/dmg/apk 等。下载后需要自行编译构建才能使用，适合有一定开发经验的用户。如果你不熟悉编译流程，建议寻找同类开箱即用的替代方案。
注意事项
- 本工具仅供学习和研究使用，请遵守相关法律法规。
- 请尊重内容创作者版权，勿将下载内容用于商业或非法传播。
- 项目源码地址：https://github.com/rookie-luochao/openapi-ui