产品简介
openapi-devtools OpenAPI DevTools 是一个浏览器扩展,能自动从网络请求中生成 OpenAPI 3.1 规范,帮助开发者轻松发现 API 行为,无需手动编写文档。适合需要 API 文档的开发者、测试人员和 API 设计者使用。
核心功能
- 为任何网站或应用即时生成 OpenAPI 3.1 规范
- 自动合并每个端点的请求和响应头、体、查询参数
- 点击路径参数,自动合并现有和未来匹配的请求
- 使用 Redoc 在工具内查看规范,并一键下载
- 任何时间导出和保存会话,或与他人共享
快速开始
- 在 Chrome 或 Firefox 应用商店安装 OpenAPI DevTools 扩展
- 打开浏览器开发者工具(按 Cmd+I 或 Ctrl+I),选择 OpenAPI 标签
- 浏览目标网站或应用,扩展自动生成 API 规范
界面预览
与其他方案对比
| 对比项 | 本工具 | 同类商业软件 | 在线服务 |
|---|---|---|---|
| 费用 | 开源免费 | 通常收费或含广告 | 可能有订阅或上传限制 |
| 隐私 | 本地运行,数据自持 | 依赖厂商政策 | 需上传数据到服务器 |
| 可定制性 | 源码开放,社区活跃 | 受限于官方功能 | 功能固定 |
适合谁用
- 正在开发或测试 REST API 的后端开发者
- 需要自动化生成 API 文档的软件工程师
- 进行 API 集成测试的测试工程师
下载与版本
当前最新版本为 v1.5.2,发布于 2024-03-26。支持 多平台。点击页面「下载软件」按钮即可下载打包好的版本,根据你的电脑/手机系统来选择对应的软件。
注意事项
- 本工具仅供学习和研究使用,请遵守相关法律法规。
- 请尊重内容创作者版权,勿将下载内容用于商业或非法传播。
- 项目源码地址:https://github.com/AndrewWalsh/openapi-devtools