正式发布 OpenAPI 3.0

  2017 年 7 月 26 日

我们很高兴地宣布下一代的 OpenAPI 规范 (OAS) 已正式发布!

OAS 3.0 基于原始 Swagger 2.0 规范,旨在提供一种标准格式,以统一行业如何定义和描述 RESTful API。OAS 3.0 的发布标志着 API 经济增长的一个重要里程碑——它汇集了各行各业的合作者,以开放和透明的方式改进规范,以满足全球 API 开发人员和消费者的需求。

当 Swagger 团队在 2015 年加入 SmartBear 时,SmartBear Software 将 Swagger 2.0 规范捐赠给了 OpenAPI Initiative。我们很高兴看到依赖该规范设计、记录和开发 API 的 API 提供商如何通过 OAS 3.0 进一步发展其 API 开发。

要了解有关 OpenAPI 3.0 新功能的更多信息,请参加我们在 9 月 26 日举行的免费培训,OpenAPI 3.0:如何使用最新的 OpenAPI 规范 3.0 设计和记录 API

OAS 3.0 有哪些新功能?

OAS 3.0 的开发是一项真正的协作努力——不仅包括 OpenAPI 技术开发委员会的成员和 OAI 的 27 名成员,还包括数千名为该工作做出贡献、提交拉取请求并提供反馈的开发人员和架构师,这有助于推动规范的演变。

我们将在未来几周内发布许多关于 OAS 3.0 的新资源和培训,但现在让我们概述一下 3.0 中您可以期待的一些新更新和功能

  • 规范的整体结构已重构,以提高可重用性
  • 添加了对描述回调的支持
  • 链接以表达操作之间的关系
  • JSON 模式包括对以下内容的支持:oneOf、anyOf 和 not
  • 改进的参数描述,包括使用架构的能力
  • 更好地支持多部分文档处理
  • Cookie 参数已加入;dataForm 参数已删除
  • 主体参数有自己的实体
  • 更好地支持内容类型协商
  • 安全定义已简化和增强

这对 Swagger 意味着什么?

关于具有新名称的新规范的发布对 Swagger 的未来意味着什么,有很多疑问。作为一个围绕规范开发工具 6 年以上的团队,Swagger 项目将继续是一类高质量的工具,以更好地实现 OAS。

Swagger 产生的一些工具包括 Swagger UISwagger Editor。Swagger UI 使 OpenAPI 规范(以前的 Swagger 规范)焕发活力,允许用户以易于阅读和理解的格式可视化 API 并与之交互。Swagger Editor 是另一个流行的开源项目,它是使用 OpenAPI 规范设计 API 的事实上的开源编辑器。这些只是 Swagger 继续开发和增长的众多工具中的一部分,旨在让开发人员和使用者能够利用 OAS 的优势。

我们将继续投资改进这些工具和其他 Swagger 项目,以充分利用 OAS 3.0 的强大功能。在未来几周内,我们将分享更多关于 3.0 支持何时会添加到不同 Swagger 工具的详细信息,以及 3.0 对 SwaggerHub 平台的意义。此外,您还可以期待在未来几周、几个月和几年内看到团队发布一些令人兴奋的新 Swagger 项目!

OAS 3.0 对使用 Swagger 2.0 的 API 意味着什么?

短期内 - 没什么。您可以继续将 Swagger 2.0 与任何 Swagger 工具、SwaggerHub 或任何其他支持 2.0 规范的平台一起使用。在可预见的未来,我们将继续支持使用 2.0 规范。

我们正在开发工具来帮助向 3.0 过渡的过程,因此请密切关注接下来的内容。

了解更多:想为您的 API 创建 OpenAPI 3.0?Swagger Inspector 助您一臂之力

我在哪里可以了解有关 OAS 3.0 的信息?

在 Swagger,我们非常关心 OpenAPI 规范,因此我们不断为人们创建资源,以了解更多信息。以下是我们最喜欢的 OAS 3.0 资源列表

我们鼓励您也浏览 GitHub 上的 OAI 3.0 文档,了解 OAS 3.0 中的新功能。

在此处阅读 OpenAPI Initiative 的完整公告。

开始使用 OpenAPI 3.0

您可以使用 SwaggerHub 中的 OpenAPI 3.0 开始设计和记录新的和现有的 API。SwaggerHub 编辑器允许您使用 OpenAPI 3.0 定义和可视化您的 API,或将使用 Swagger 2.0 定义的现有 API 转换为最新版本的规范。您还可以使用 Swagger Inspector 从您现有的 API 轻松生成 OAS 3.0 定义。查看 迁移到 OpenAPI 3.0:如何使用 Swagger 工具转换现有 API 以了解更多信息!

立即开始