SwaggerHub 新功能:OpenAPI 规范 3.1

  2023 年 7 月 14 日

Swagger 对 OpenAPI 3.1 支持的发布之后,我很高兴地宣布我们已初步支持 OpenAPI 3.1。

TL;DR – 在 SwaggerHub 中,您现在可以

  • 使用 SwaggerHub 作为单一事实来源,对 OpenAPI 3.1 API 进行编目。
  • 使用全新、更强大的 Swagger Editor 设计 OpenAPI 3.1 API。
  • 保留所有 API 的文档,包括使用 OpenAPI 3.1 和 AsyncAPI 的 API。
  • 利用 OpenAPI 3.1 的新功能,例如支持 JSON Schema 2012-12。

本次发布仅仅是 SwaggerHub 的开始,我们承诺很快为您带来对 OpenAPI 3.1 的全面支持。以下详细说明了上述要点,以及我们为实现与 OpenAPI 3.1 的功能对等,从而提供完整的 API 开发和管理工作流程的计划。

查看 SwaggerHub OAS 3.1 文档

在 SwaggerHub 中构建对 OpenAPI 3.1 的支持

虽然仅仅增加一个“点一”版本看起来像是次要发布,但它带来了我们现在描述模型和模式的方式的重大解耦——即在 API 请求和响应中流动的 JSON、XML 和表单主体的形状。

OpenAPI 3.1 支持 JSON Schema 的全部范围(特别是撰写本文时最新的 JSON Schema Draft 2020-12),并且理论上支持任何版本的 JSON Schema(尽管作为工具制造商,我们在 Swagger 中对此有所限制。请参见下文了解不支持的内容)。

这意味着什么?

历史上,OpenAPI 支持 JSON Schema 的一个子集,甚至对相同的关键字有不同的语义。这意味着重用模式需要将它们在“OpenAPI 风格的 JSON Schema”和其他标准 JSON Schema 版本之间进行转换,从而降低了描述模式事实来源的能力并限制了重用。

OpenAPI 在其支持的 JSON Schema 功能方面也一直比较保守。这对工具制造商来说是好事,他们能够完全支持 OpenAPI,但也留下了一些功能——这些功能可以更强大地描述真实的 API。

现在 OpenAPI 已全面支持 JSON Schema,我们可以期待两件事:

  1. 考虑到 JSON Schema 的强大和复杂性,工具将缓慢地实现功能对等。
  2. OpenAPI、AsyncAPI、JSON Schema 工具以及其他潜在规范之间的可重用性将爆炸式增长。

Swagger 和 SwaggerHub 在这方面处于什么位置?

在开源领域,各个 Swagger 项目一直在逐步地、有时甚至是完全地重写自身,以支持 OpenAPI 3.1,从核心的 Java 和 JavaScript 库,到面向用户的工具,如 Swagger Editor 和 Swagger UI。除了一个显著的例外,Swagger Codegen 的工作仍在继续。阅读更多:Swagger 支持 OAS 3.1

在 SwaggerHub 中编目 OAS 3.1 中的 RESTful API

SwaggerHub 很荣幸地宣布,其编目功能现在也完全支持 OpenAPI 3.1。

到目前为止,那些已经开始使用 OAS 3.1 创建 API 的团队无法将其存储在 SwaggerHub 中——但今天,这种情况改变了。您可以创建或导入 OAS 3.1 API 到 SwaggerHub,为所有 API 资产组合管理提供单一事实来源。

其中三个例子是:

  • 创建、搜索和筛选您的 OpenAPI 3.1 定义。
  • 使用全新、更强大的 Swagger Editor 设计 OpenAPI 3.1 定义。
  • 使用自定义审查规则标准化 OpenAPI 3.1。
  • 当然,还可以使用交互式文档进行查看和试用。

使用 SwaggerHub 的好处是集中编目这些不同的 API,支持协作工作流,并通过标准化和治理降低成本。将 RESTful 和事件驱动型 API 紧密结合是管理 API 资产组合的重要一步。

通过这个单一的 API 目录,开发人员、架构师、设计师和消费者都可以从改进的发现和增强的治理中受益。

阅读更多

在 SwaggerHub 中设计 OAS 3.1 中的 RESTful API

新的 Swagger Editor 在 2022 年底的发布是我们迈向现在的重要里程碑,它支持使用 OpenAPI 3.1 设计 RESTful API。新编辑器的一个重大进步是能够支持多种 API 规范,同时确保易于扩展。

现在,您可以在 OAS 3.1 中创建、文档化和测试 RESTful API,同时保持当前的最佳实践和标准。

开始使用新的 Swagger Editor

在 SwaggerHub 中文档化 OAS 3.1 中的 RESTful API

在 SwaggerHub 中,为使用 OAS 3.1 规范编写的 API 保持准确、最新的文档。在设计过程中自动生成交互式文档,以便 API 消费者和内部用户都可以了解并使用您的 API。

在一个中心平台中导入或托管 OAS 3.1 API 和 AsyncAPI 定义,并管理文档的版本控制和发布,以确保一致性。

阅读更多

下一步是什么?

本次初步发布是我们的起点。我们致力于在 SwaggerHub 中全面扩展 OAS 3.1 支持。接下来,我们将构建管理 API 生命周期所需的更多关键功能,例如推进协作和集成。

© . All rights reserved.