关于项目
OpenAPI DevTools是一个浏览器扩展,可以从网络请求中实时生成OpenAPI规范。安装后,它会在开发者工具中添加一个名为OpenAPI
的新标签页。当工具打开时,它会自动将网络请求转换为规范。
功能:
- 只需使用任何网站或应用程序,即可立即生成OpenAPI 3.1规范
- 自动合并每个端点的新请求和响应头、主体和查询参数
- 点击路径参数,应用程序将自动合并现有和未来的匹配请求
- 使用Redoc在工具内查看规范,并一键下载
- 随时导出和保存会话,或与他人分享
(返回顶部)
安装
否则,手动安装:
- 下载并解压最新版本中的dist.zip文件
- 在Chrome中,导航到
chrome://extensions
- 在右上角启用
开发者模式
开关 - 在左上角点击
加载已解压的扩展程序
,选择解压后的dist
目录 - 打开新标签页,然后在开发者工具中选择
OpenAPI
(使用cmd+i
或ctrl+i
打开) - Firefox安装较为困难。请使用附加组件商店。
(返回顶部)
使用方法
当您浏览网页时,规范将根据触发的JSON请求自动填充。在设置菜单中,您可以过滤主机并参数化URL中的路径。完成后,所有匹配该端点的现有和未来请求都将被合并。此过程不可逆,但您可以随时清除规范并重新开始。
当同一端点响应不同的数据时,比如某个值有时是字符串,有时是null,该值的规范将是字符串或null。最终规范中会考虑所有信息。如果您发现请求中缺少某些内容,请触发包含缺失信息的请求。
设置菜单包含多个选项。在这里,您可以在规范中启用真实示例。您还可以将应用程序的当前状态导出为字符串,分享或存储它,并在以后导入。
(返回顶部)
什么是OpenAPI?
OpenAPI规范是对API期望接收和响应内容的描述。它由OpenAPI Initiative和Linux基金会管理。OpenAPI规范是RESTful API的现代标准,拥有这些规范的系统更易于使用。
(返回顶部)
贡献
要开发该项目:
npm install
npm run dev
(返回顶部)