openapi-devtools

<a name="readme-top"></a>

<!-- 项目标志 --> <br /> <div align="center"> <a href="https://github.com/AndrewWalsh/openapi-devtools"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/73d8d911-7fe6-45b1-a9bc-364b724a4d98.svg" alt="Open API开发工具" width="300" height="250"> </a> <p align="center" style="max-width: 600px;"> 通过一个浏览器扩展轻松发现API行为，它可以为任何应用或网站实时自动生成OpenAPI规范。 <br /> <br /> <a href="https://awalsh.io/posts/openapi-devtools/">了解更多</a> · <a href="https://github.com/AndrewWalsh/openapi-devtools/issues">报告Bug</a> · <a href="https://forms.gle/fA2EtvamUrsRxXKYA">提供反馈</a> </p> </p> </div>

关于项目

<p align="center" width="100%"> <img width="80%" src="https://yellow-cdn.veclightyear.com/835a84d5/a42006b7-e48a-4df2-b808-4ab2031e5c24.gif"> </p>

OpenAPI DevTools是一个浏览器扩展，可以从网络请求中实时生成OpenAPI规范。安装后，它会在开发者工具中添加一个名为OpenAPI的新标签页。当工具打开时，它会自动将网络请求转换为规范。

功能：

• 只需使用任何网站或应用程序，即可立即生成OpenAPI 3.1规范
• 自动合并每个端点的新请求和响应头、主体和查询参数
• 点击路径参数，应用程序将自动合并现有和未来的匹配请求
• 使用Redoc在工具内查看规范，并一键下载
• 随时导出和保存会话，或与他人分享

<p align="right">(<a href="#readme-top">返回顶部</a>)</p>

安装

<p align="center" width="100%"> <img width="80%" src="https://yellow-cdn.veclightyear.com/835a84d5/8f19d08b-c515-4f18-8a2f-af9dfe1212ec.png"> </p>

在Chrome网上应用店下载扩展。

在Firefox附加组件商店下载扩展。

否则，手动安装：

• 下载并解压最新版本中的dist.zip文件
• 在Chrome中，导航到chrome://extensions
• 在右上角启用开发者模式开关
• 在左上角点击加载已解压的扩展程序，选择解压后的dist目录
• 打开新标签页，然后在开发者工具中选择OpenAPI（使用cmd+i或ctrl+i打开）
• Firefox安装较为困难。请使用附加组件商店。

<p align="right">(<a href="#readme-top">返回顶部</a>)</p>

使用方法

当您浏览网页时，规范将根据触发的JSON请求自动填充。在设置菜单中，您可以过滤主机并参数化URL中的路径。完成后，所有匹配该端点的现有和未来请求都将被合并。此过程不可逆，但您可以随时清除规范并重新开始。

当同一端点响应不同的数据时，比如某个值有时是字符串，有时是null，该值的规范将是字符串或null。最终规范中会考虑所有信息。如果您发现请求中缺少某些内容，请触发包含缺失信息的请求。

设置菜单包含多个选项。在这里，您可以在规范中启用真实示例。您还可以将应用程序的当前状态导出为字符串，分享或存储它，并在以后导入。

<p align="right">(<a href="#readme-top">返回顶部</a>)</p>

什么是OpenAPI？

OpenAPI规范是对API期望接收和响应内容的描述。它由OpenAPI Initiative和Linux基金会管理。OpenAPI规范是RESTful API的现代标准，拥有这些规范的系统更易于使用。

<p align="right">(<a href="#readme-top">返回顶部</a>)</p>

贡献

要开发该项目：

• npm install
• npm run dev

<p align="right">(<a href="#readme-top">返回顶部</a>)</p> <!-- MARKDOWN链接和图片 --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->