每个人都在谈论 OpenAPI 3.0。您的老板可能听某个分析师提及过它，路边那家酷炫的初创公司的朋友们用它来更好地定义他们的微服务应用，而您的产品经理表亲在上个感恩节时更是对它让 API 使用变得多么容易赞不绝口。
您对此很感兴趣，经过一番研究，您已经意识到使用 OAS 3.0 定义 API 是多么有益。但是，如果那些对 OpenAPI 赞不绝口的人在实现 API 之前，就先使用该规范设计了他们的 API 呢？您的公司拥有数十个传统 API，它们早在 OpenAPI 流行之前就已经实现和部署了。
那么，如何从现有 API 创建 OpenAPI 文档呢？
您可以花费数小时研究最佳插件来帮助您生成此规范，确保插件支持实现语言，然后花费更多时间使用此插件注释您的每个 API 端点，最终创建此规范。或者，您只需点击几下，即可使用 Swagger Inspector 对生成 OpenAPI 3.0 文档的最新支持。
OpenAPI 3.0 简化
OpenAPI 永远改变了 REST API 的格局。它为人类和机器理解、使用和消费 API 提供了一个通用框架。它充当了开发人员轻松构建 API 的标准模板，详细说明了不同的资源及其相关的请求-响应周期。OpenAPI 3.0 在之前的 Swagger 2.0 规范之上带来了大量附加功能，其中包括：
- 规范的整体结构经过重构，以提高可重用性
- 增加了对描述回调的支持
- 链接用于表达操作之间的关系
- JSON schema 支持：oneOf、anyOf 和 not
- 改进的参数描述，包括使用 schema 的能力
- 更好地支持多部分文档处理
- 支持 Cookie 参数；取消了 dataForm 参数
- 请求体参数拥有独立的实体
- 更好地支持内容类型协商
- 安全定义已简化和增强
OpenAPI 3.0 定义有助于自动化不同的 API 生命周期流程，包括创建交互式、对消费者友好的文档，原型化客户端 SDK 和生成测试用例。
每个人都希望充分利用 OpenAPI 3.0，显然它为您的 API 提供了许多出色的功能。但是 Swagger Inspector 对 OAS 3.0 的新支持与这一切有什么关系呢？
从现有 API 即时生成 OpenAPI 3.0
设计优先方法提倡在实际编码、实现、测试和文档编写之前，先使用 OpenAPI 规范设计 API。然而，尽管设计优先方法是每个开发人员都应该努力实现的目标，但它并非总是易于完成。
很多时候，组织拥有大量已实现和部署的现有 API，但没有任何定义。此外，公司或团队在未来的 API 项目中不采用设计优先方法也有许多实际原因。
这就是 Inspector 的用武之地。使用 Swagger Inspector，您可以告别耗时的、代码优先的 OpenAPI 生成困境！Inspector 允许您通过几次点击，在几分钟内从现有 API 端点生成 OpenAPI 定义。为此，请将您希望在 OpenAPI 中定义的 API 的基本 URI 和路径插入到表单字段中。如果需要，您随时可以添加任何身份验证、标头或查询参数，然后点击发送。
获得有效响应后，您可以从右侧面板的“历史记录”选项卡下生成 OpenAPI 文件。Inspector 的妙处在于，您可以将多个端点合并到一个 OpenAPI 文件中，该文件会自动推送到 SwaggerHub（设计和文档平台），在那里您可以进一步编辑文档、生成客户端 SDK、创建交互式文档等等！
轻松解析和测试 OpenAPI 端点
开发人员在开发过程中需要不断地复核他们的 API 和端点是否按预期工作。没有人喜欢新流程，尤其是开发人员。
对于使用已在 OpenAPI 中定义的 API 的开发人员，Swagger Inspector 提供了一种简单的方法来解析 OpenAPI 3.0 文件，查看整个 API 中的各种端点和方法，使他们能够选择要测试的资源。
只需插入 API 定义的位置，或上传一个 OpenAPI 文件。例如，这是 SmartBear Petstore API（在 OAS 3.0 中定义）在 SwaggerHub 上的位置。只需将此位置插入到 Inspector 中，然后点击“发送”。如果它是一个有效的 OpenAPI 3.0 定义，您就可以通过“使用定义”按钮查看 API 中的所有端点。
从这里开始，您可以选择要验证的端点和方法，并查看响应是否符合您的预期！
最后，只需转到历史记录选项卡，选择您刚才测试的端点。在那里，点击“创建 API 定义”下拉菜单并选择 OAS 3.0。您需要创建一个帐户才能完成定义生成。
当我们说我们了解 OpenAPI 时，我们是认真的。OAS 是推动和加速您 API 开发的最佳开放标准，我们希望 Swagger Inspector 能为您提供一个轻松入门 OAS 3.0 规范的方式。
感谢您的阅读！正在寻找更多 API 资源？订阅 Swagger 新闻简报。每月接收我们的最佳 API 文章、培训、教程等内容的电子邮件。 订阅