作为 SwaggerHub 持续支持最新版 OpenAPI 规范(OpenAPI 3.0,即 OAS 3.0)的努力一部分,团队很高兴地宣布在平台的一项关键功能——域——中提供支持。
OAS 3.0 允许开发人员将常用对象、路径项、响应等存储在一个列表中,以便在整个 API 定义中引用。SwaggerHub 域将此功能提升到新的水平,将可重用资产列表移动到单独的文件中,从而使其可以在多个不同定义中被引用和使用。
借助 SwaggerHub 中的权限和共享功能,少数用户可以定义高级资产,这些资产随后可在大型团队和设计工作中被引用。这些可重用域可以进行版本控制、发布和共享,以获取协作反馈。
域如何帮助构建更好的 API?
通常,随着开发项目的范围和规模增长,新变更的审查和验证过程可能成为整个交付流程中瓶颈的催化剂。许多团队依靠测试、代码检查工具或同行评审来验证并确保新服务符合组织样式指南——但在许多情况下,这些方法容易失败。而且,由于这些过程发生在大部分开发完成之后,修复问题的成本远高于在流程早期修复的成本。
域允许团队在设计阶段解决样式问题,而无需在新功能编写任何一行代码之前。验证和更改可以在开销极低的情况下进行,从而在开发后期阶段带来更大的信心,同时也将修复问题的成本降至最低。
结合我们的 API 标准化功能,团队可以创建在更改时强制执行的高级指南,从而使审查和验证阶段能够专注于功能,而不是服务的样式和结构。从同一设计中公开的文档将共享通用示例和结构,而不是在构建/部署过程中编写或生成的文档。
探索域
SwaggerHub 的所有计划都提供域功能!有关在定义中配置和引用域的更多信息,我们的文档中提供了多项资源,助您入门。
如果您有兴趣了解更多关于域如何与我们的 API 标准化功能结合使用以在设计和项目之间强制执行指南,我们最近举办了一场网络研讨会,其中探讨了我们 API 状况调查中关于 API 设计的一些结果,并演示了 SwaggerHub 内的功能。