今年标志着 OpenAPI 3.0 的正式发布,它是 OpenAPI 规范的最新版本。
对于参与 API 开发的人来说,OAS 3.0 的发布是,嗯... 算是件大事。
为什么?发布如此重要的最显着的原因之一是,OpenAPI 3.0 是该规范自 2015 年被 SmartBear Software 捐赠给 OpenAPI 倡议,并从 Swagger 规范更名为 OpenAPI 规范以来的第一个正式版本。
在我们深入探讨 OpenAPI 3.0 对 API 领域如此重要的一些原因之前,首先澄清一些关于 OpenAPI 的问题以及它对 Swagger 的意义非常重要。
在过去的两年中,关于从 Swagger 到 OpenAPI 的变化有很多疑问。并且对于 OpenAPI 和 Swagger 之间的区别、何时使用一个名称而不是另一个名称,以及 OpenAPI 和 Swagger 之间的关系也存在很多困惑。
让我们首先澄清 Swagger 与 OpenAPI 的区别
理解差异的最简单方法是
- OpenAPI = 规范
- Swagger = 用于实现规范的工具
OpenAPI 是规范的正式名称。该规范的开发由 OpenAPI 倡议推动,该倡议涉及来自科技界不同领域的 30 多个组织,包括微软、谷歌、IBM 和 CapitalOne。领导 Swagger 工具开发的 Smartbear Software 也是 OpenAPI 倡议的成员,帮助领导规范的演变。
Swagger 是与一些最著名和广泛使用的用于实现 OpenAPI 规范的工具相关的名称。Swagger 工具集包括开源、免费和商业工具的组合,这些工具可以在 API 生命周期中的不同阶段使用。
这些工具包括
由于 Swagger 工具是由参与创建原始 Swagger 规范的团队开发的,因此这些工具通常仍然被视为与该规范同义。但是 Swagger 工具并不是唯一可用于实现 OpenAPI 规范的工具。有各种各样的 API 设计、文档、测试、管理和监控解决方案支持规范的 2.0 版本,并且正在积极致力于添加 3.0 支持。
您可以在 GitHub 上找到提供 对最新版本的 OpenAPI 规范支持的工具的完整列表。
为什么 Swagger 工具没有将其名称更改为 OpenAPI?
Swagger 生态系统始终由规范及其周围的核心开源工具组成,最著名的是 Swagger UI、Swagger Editor 和 Swagger Codegen。该规范被如此广泛采用的一个重要原因是它附带的工具。
SmartBear 捐赠了该规范,但由于开发人员、技术作家、测试人员和设计人员与该工具的强烈联系,流行的开源 Swagger 工具仍然保留了原始品牌。该规范不是,也从未仅仅与 Swagger 工具相关联。事实上,捐赠该规范并成立 OpenAPI 倡议的决定是为了确保 OpenAPI 保持完全的供应商中立。这就是为什么我们很高兴看到 API 领域的如此多公司,包括也支持其他定义格式(如 API Blueprint 和 RAML)的公司加入该倡议。
Swagger 团队仍然专注于构建最强大且易于使用的工具,用于使用 OpenAPI 规范设计、编写文档、开发和测试 API,并将继续发展和完善我们的工具集以支持 OpenAPI。这些工具将继续保留 Swagger 名称。Swagger.io,Swagger 工具和开源 Swagger 项目的在线主页,也将继续成为了解 Swagger 工具的首选之地,我们还将继续通过培训、教程、网络研讨会和 OpenAPI 使用文档为 OpenAPI 规范知识做出贡献。
了解 OpenAPI 和 Swagger 社区
虽然为 OpenAPI 做出贡献的人和为 Swagger 工具做出贡献的人之间总是存在重叠,但这两个社区是相互独立的。
正如本文所述,OpenAPI 倡议是一个开放的、供应商中立的组织,欢迎任何希望在其 API 开发中帮助发展或利用该规范的人参与。欢迎组织加入越来越多的为该规范做出贡献的成员名单,也欢迎个人通过在 GitHub 上分享想法和反馈或参加每月在全球各地举行的 OAS 聚会来参与。在此处了解有关如何做出贡献的更多信息。
Swagger 工具本身有一个社区,专注于帮助改进一些现有的 Swagger 项目,并引入新的想法和功能请求。Swagger 社区由 SmartBear Software 的团队推动,该团队投资于开源 Swagger 工具的开发,但也受到世界各地成千上万的 Swagger 用户的贡献的推动。如果您想加入 Swagger 社区,我们邀请您在 GitHub 上找到我们或加入 Swagger API Meetup 小组。您还可以在 Swagger 博客或 Twitter 上的 @SwaggerAPI 上找到最新的新闻和更新。
展望 OpenAPI 的光明未来
我们期待看到 OpenAPI 成为 API 领域每个人都认可的名称,我们很高兴成为越来越多的 OpenAPI 倡议成员社区的一份子。
希望本文能帮助澄清一些关于 OpenAPI 及其与 Swagger 关系的问题。
总结一下
- 该规范在 2015 年被重命名为 OpenAPI 规范。OpenAPI 3.0 是该规范的最新版本。
- Swagger 工具由 SmartBear Software 支持,是用于实现 OpenAPI 规范的最流行的工具之一,并将继续保留 Swagger 名称(Swagger 编辑器、Swagger UI、SwaggerHub 等)。
- 还有数百种其他与 Swagger 无关的开源和专业工具支持 OpenAPI 2.0 规范,并且支持 3.0 的工具列表正在不断增长。
- OpenAPI 和 Swagger 都有开源社区,并欢迎所有贡献者加入以分享他们的想法并参与其中。
如果您有同事、朋友或任何其他使用 API 但仍有这些问题的人,我们希望您能分享这篇文章。Swagger 团队将努力帮助澄清 Swagger 和 OpenAPI 之间的关系,我们也希望您能这样做!
Swagger 入门:OAS 和 Swagger 工具简介
加入我们在 11 月 14 日举行的免费培训,它将介绍 Swagger 工具生态系统和 OpenAPI 规范。了解更多信息。