跳至主要内容

OpenAPI 规范 3.1.0 发布

作者 2021 年 2 月 18 日公告, 博客

OpenAPI 开发人员社区和 JSON Schema 社区共同努力构建升级,以支持与最新 JSON Schema 草案的 100% 兼容性

旧金山 - 2021 年 2 月 18 日 - OpenAPI Initiative 是一个由面向未来的行业专家组成的联盟,专注于创建、发展和推广 OpenAPI 规范 (OAS),这是一种与供应商无关的开放式描述格式,用于 HTTP(包括 RESTful)API,今天宣布 OpenAPI 规范 3.1.0 已发布。这个新版本现在支持与最新草案 (2020-12) 的 JSON Schema 的 100% 兼容性。

随着此版本的发布,OpenAPI Initiative 赞助了新文档的创建,以使其更容易理解规范的结构及其优势。它可在此处获得:https://oai.github.io/Documentation/ 

OpenAPI 规范是描述现代 API 的广泛采用的行业标准。它定义了 HTTP API 的标准、与编程语言无关的接口描述,使人类和计算机能够在不需要访问源代码、其他文档或检查网络流量的情况下发现和理解服务的 capabilities。

OpenAPI 规范 (OAS) 被全球组织使用,包括 Atlassian、彭博社、eBay、谷歌、IBM、微软、甲骨文、Postman、SAP、SmartBear、Vonage 等等。

“使用 OpenAPI 规范的好处广泛适用,从 API 生命周期管理到文档,再到安全、微服务开发等等,”谷歌产品经理、OpenAPI Initiative 技术指导委员会成员 Marsh Gardiner 表示。“在演变到 3.1.0 版本时,我们非常谨慎,以确保它对现有用户来说是一个增量升级,同时也是企业环境中立即评估和采用的极佳候选者。我们对多元化的贡献者群体表示衷心的感谢,感谢他们为我们最新的成就贡献了所有非凡的技能和努力。”

“OpenAPI JSON Schema 类结构与 JSON Schema 本身之间的不匹配长期以来一直是用户和实施者的一个问题。OpenAPI 3.1.0 与 JSON Schema 草案 2020-12 的完全一致,不仅能为用户节省许多痛苦,而且还开创了一种新的标准化 schema 扩展方法,”JSON Schema 项目负责人 Ben Hutton 表示。“在过去几年(和版本)中,我们一直在确保自己能够清晰地听到并了解社区面临的问题。凭借我们时间有限的志愿者工作,我们不仅修复了许多痛点并添加了新功能,而且 JSON Schema 词汇表允许定义适用于验证之外用例的标准,例如代码、UI 和文档的生成。

在 JSON Schema 草案 2020-12 发布的第一天,就有两个实现准备就绪。与这样一支经验丰富且技术精湛的团队合作,令人深感谦卑。”

虽然 JSON Schema 从技术上讲仍然是“草案”规范,但草案 2020-12 为第三方构建标准化扩展奠定了新的稳定基础。JSON Schema 团队没有预见到扩展系统(如方言和词汇表)方法的任何重大变化。然而,随着反馈的接收,实用性可能会得到改善。

JSON Schema 网站:https://json-schema.org 

JSON Schema Open Collective:https://opencollective.com/json-schema 

JSON Schema Twitter:https://twitter.com/jsonschema

OpenAPI 规范 3.1.0 中的主要更改

  • JSON Schema 词汇表对齐
  • 用于描述在带外注册和管理的 Webhook 的新顶级元素
  • 支持使用标准 SPDX 标识符识别 API 许可证
  • PathItems 对象现在是可选的,以便更轻松地创建可重用组件库。可重用 PathItems 可以用 components 对象进行描述。此外,还支持描述使用客户端证书保护的 API。

完整的 OpenAPI 规范 3.1.0 版本说明可在此处获得:https://github.com/OAI/OpenAPI-Specification/releases/tag/3.1.0

关于语义版本控制的说明

OpenAPI Initiative 已采用语义版本控制来传达软件升级中更改的重要性。语义版本控制是一种流行的编号方法,其中次要版本更新表示对软件的更改向后兼容,而主要更新则不兼容。从技术上讲,在使用语义版本控制时,新的与 JSON Schema 的完全一致性需要将此更改表示为 4.0.0。但是,对 OpenAPI 的此更新是重要的改进,特别是与 JSON Schema 的一致性,但将其强制为主要版本编号会导致期望不一致。

特别感谢

特别感谢 Henry Andrews、Phil Sturgeon 和 Ben Hutton 为更好地将 JSON Schema 与 OpenAPI 规范对齐所做的一切工作、支持和耐心的解释。感谢 Lorna Mitchell 推动 Webhook 工作,利用我们新的提案流程。并感谢全球众多参与的开源开发人员。

OpenAPI 资源

要了解更多关于参与 OpenAPI 规范演变的信息:https://www.openapis.org.cn/participate/how-to-contribute

●   成为会员

●   OpenAPI 规范 Twitter

●   OpenAPI 规范 GitHub – 立即开始!

●   分享您的 OpenAPI 规范 v3 实现

关于 OpenAPI Initiative

OpenAPI Initiative (OAI) 由一组面向未来的行业专家创建,他们认识到标准化 API 描述方式的巨大价值。作为 Linux 基金会下属的开放式治理结构,OAI 专注于创建、发展和推广与供应商无关的描述格式。OpenAPI 规范最初基于由 SmartBear Software 捐赠的 Swagger 规范。要参与 OpenAPI Initiative,请访问 https://www.openapis.org.cn

关于 Linux 基金会

Linux 基金会成立于 2000 年,由 1000 多个成员支持,是全球领先的开源软件、开放标准、开放数据和开放硬件协作中心。Linux 基金会项目(如 Linux、Kubernetes、Node.js 等等)被认为对全球最重要基础设施的开发至关重要。其开发方法利用了成熟的最佳实践,并满足了贡献者、用户和解决方案提供商的需求,以创建可持续的开放协作模型。有关更多信息,请访问 linuxfoundation.org。