看到一个小型的、叛逆的开源项目如何改变整个行业的看法,这真是令人着迷。这就是 Swagger 规范所发生的事情,这个开源的 API 设计标准发展出了一整个开发者社区,围绕它建立了一个强大的工具生态系统,并最终发展成为 OpenAPI 规范 (OAS),这是世界定义 RESTful 服务的标准。作为 Swagger 规范初始版本背后的公司和团队,能够参与这项创新是一项荣幸。今天,我们很高兴地宣布在 SwaggerHub 中支持 OpenAPI 规范的下一个版本 3.0。
为何使用 OpenAPI 规范 3.0
OAS 3.0 为您的 API 设计带来了各种丰富而富有表现力的功能。结构已经过重构,变得更加简单。例如,参数、响应、示例等可重用对象被整合到组件对象下,而令人困惑的 body 参数被 requestBody 取代,后者还将 formData 分组在其下。还有一系列新功能,如链接、回调、多个服务器主机和更好的安全定义。您可以在我们即将进行的培训中了解有关所有新更改的更多信息:
OpenAPI 3.0:如何使用最新的 OpenAPI 规范设计和记录 API。 OAS 3.0 的功能丰富的描述集使架构师、开发人员和技术文档编写人员能够更好地描述其 API,而没有限制,并带来增强的用户体验。行业正在推进 OAS 3.0 的采用,并且有新的工具围绕该规范构建。上个月,我们在
Swagger 编辑器和 UI 和
Swagger Core 中提供了对 OAS 3.0 的支持,现在已将其扩展到 SwaggerHub,以便您的团队可以使用 OAS 3.0 协作进行 API 设计和文档流程。
SwaggerHub 可以提供什么?
设计和文档
SwaggerHub 编辑器支持 OAS 3.0,用于设计和记录 REST API。这意味着您可以在设计 API 时利用编辑器的自动完成、错误反馈和语法验证功能,同时可视化您的 OAS API。SwaggerHub 还会自动生成并托管您 OAS 定义的 API 的文档,因此您可以在一个平台上满足所有 API 设计和文档需求。在创建新 API 时,您可以指定要使用的规范版本,从而灵活地以最适合您需求的规范定义 API。如果您选择导入定义,SwaggerHub 还可以自动确定规范的类型。通过 OAS3.0 徽章,可以轻松识别您的 API 是否在 SwaggerHub 上以最新的 OAS 定义。

Swagger 到 OAS 3.0 转换
每当引入新版本的框架时,最大的挑战之一就是迁移。SwaggerHub 可以帮助您将现有的 Swagger 2.0 规范转换为最新的 OAS 3.0。此即时转换将在
-oas3 后缀中创建您的 API 的新版本。您的原始 API 版本将保持不变。

这意味着您不再需要花费数小时试图破译和更改 API 定义中的每一行,或者使用插件在 API 中摸索以升级到最新版本,只需点击转换即可看到您的定义转换为 OAS 3.0。
太棒了!为什么 OAS 3.0 支持仍处于测试阶段?
虽然我们对使用 OAS 3.0 设计、记录、转换和协作处理 API 提供了强大的支持,但我们仍在努力提供对 OAS 3.0 的全面支持。这包括 –
- 使基于 OAS3.0 的 API 文档具有交互性
- 启用基于 OAS 3.0 的 API 的模拟功能
- 从 OAS 3.0 API 生成服务器代码和客户端 SDK
- 为 SwaggerHub 域添加 OAS3.0 支持
也就是说,我们正在积极努力尽快添加上述功能。我们始终感谢用户提出的任何反馈或功能请求,所以请随时直接发送电子邮件至
[email protected],提供关于我们对 OAS 3.0 支持的意见。
您可以从我们的帮助文档中了解更多关于使用 OAS 3.0 的信息。 开始使用 OpenAPI 3.0
您可以使用
SwaggerHub 中的 OpenAPI 3.0开始设计和记录新的和现有的 API。SwaggerHub 编辑器允许您使用 OpenAPI 3.0 定义和可视化您的 API,或将使用 Swagger 2.0 定义的现有 API 转换为最新版本的规范。
立即开始。