发布 SwaggerHub 域的 OAS 3.0 支持

  2019 年 3 月 11 日

作为 SwaggerHub 不断努力支持最新版本的 OpenAPI 规范,即 OpenAPI 3.0 (OAS 3.0) 的一部分,团队很高兴地宣布在平台的核心功能之一 — 域中提供支持。

OAS 3.0 允许开发人员获取常用的对象、路径项、响应等,并将它们存储在一个列表中,以便在您的 API 定义中引用。SwaggerHub 域将此提升到一个新的水平,将可重用资产的列表移动到一个单独的文件中,从而允许跨多个不同的定义引用和使用它。

借助 Swaggerhub 中的权限和共享功能,选定的一组用户可以定义高级资产,然后由更大的团队和设计工作引用。这些可重用的域可以进行版本控制、发布和共享,以便进行协作反馈。

域如何帮助构建更好的 API?

通常,随着开发项目的范围和规模的扩大,新更改的审查和验证过程可能会成为更大交付过程中瓶颈的催化剂。许多团队依赖测试、代码 lint 工具或同行评审来验证并确保新服务符合组织样式指南,但在许多情况下,这些容易失败。而且,由于它们是在大部分开发工作完成后发生的,因此解决问题的成本远高于在过程早期解决问题的成本。

域允许团队在为新功能编写一行代码之前,在设计阶段解决样式问题。当开销非常小时,可以进行验证和更改,从而在开发的后期阶段更有信心,同时还将解决问题的成本降至最低。

当与我们的 API 标准化功能结合使用时,团队可以创建在进行更改时强制执行的高级准则,从而允许审查和验证阶段专注于功能,而不是服务的样式和结构。从同一设计公开的文档将共享通用示例和结构,而不是在构建/部署过程中编写或生成的示例和结构。

探索域

所有 SwaggerHub 计划都提供域!有关在定义中配置和引用它们的更多信息,我们文档中有几个资源来帮助您入门。

如果您有兴趣了解如何将域与我们的 API 标准化功能配对,以在设计和项目中强制执行准则,我们最近举办了一次网络研讨会,研究了我们 API 状态调查中关于 API 设计的一些结果,以及 SwaggerHub 中功能的演示。