我们很高兴地宣布,下一代 OpenAPI 规范 (OAS) 正式发布!
OAS 3.0 基于原始的 Swagger 2.0 规范,旨在提供一种标准格式,以统一行业定义和描述 RESTful API 的方式。OAS 3.0 的发布标志着 API 经济发展中的一个重要里程碑——它汇集了各行各业的协作者,以开放透明的方式发展规范,以满足全球 API 开发者和消费者的需求。
SmartBear Software 在 2015 年 Swagger 团队加入 SmartBear 时,将 Swagger 2.0 规范捐赠给了 OpenAPI 倡议组织。我们很高兴看到那些依赖此规范来设计、文档化和开发 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 UI 和 Swagger 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 倡议组织的完整公告。
开始使用 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》了解更多信息!