每个人都在谈论 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 的标准模板，详细描述了不同的资源及其相关的请求-响应周期。在之前的 Swagger 2.0 规范之上，OpenAPI 3.0 带来了丰富的功能，其中包括：
- 重新构建了规范的整体结构，以提高可重用性
- 添加了描述回调的支持
- 链接以表达操作之间的关系
- JSON 模式包括对以下内容的支持：oneOf、anyOf 和 not
- 改进了参数描述，包括使用模式的能力
- 更好地支持多部分文档处理
- Cookie 参数已加入；dataForm 参数已移除
- Body 参数具有自己的实体
- 更好地支持内容类型协商
- 简化和增强了安全定义
OpenAPI 3.0 定义可以帮助自动化不同的 API 生命周期流程，包括创建交互式、消费者友好的文档、原型客户端 SDK 和生成测试用例。
每个人都在寻求充分利用 OpenAPI 3.0，而且显然您的 API 有一些很棒的功能。但是 Swagger Inspector 的新 OAS 3.0 支持与这一切有什么关系呢？
从现有 API 立即生成 OpenAPI 3.0
设计优先方法主张在完成实际代码、实现、测试和文档之前，首先使用 OpenAPI 规范设计 API。但是，虽然设计优先方法是每个开发人员都应该努力追求的理想方法，但它并不总是容易实现的。
很多时候，组织有大量已实现和部署的现有 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 文件。例如，这是在 SwaggerHub 上定义的 OAS 3.0 中的 SmartBear Petstore API 的位置。只需将此位置插入 Inspector 中，然后点击“发送”。如果这是一个有效的 OpenAPI 3.0 定义，您可以使用“使用定义”按钮查看 API 中的所有端点。
从这里开始，您可以选择要验证的端点和方法，并查看响应是否符合您的预期！
最后，只需继续并在历史记录选项卡中选择您刚刚测试过的端点。从那里，点击“创建 API 定义”下拉列表并选择 OAS 3.0。您需要创建一个帐户才能完成定义生成。
当我们说我们了解 OpenAPI 时，我们是认真的。OAS 是驱动和加速 API 开发的最佳开放标准，我们希望 Swagger Inspector 可以为您提供一个轻松上手 OAS 3.0 规范的方法。
感谢您的阅读！正在寻找更多 API 资源？订阅 Swagger 新闻通讯。每月接收一封电子邮件，其中包含我们最好的 API 文章、培训、教程等。订阅