专注于 API 的团队一直在寻求提高其开发工作流程中交付新功能和更新功能的速度。在 API 设计方面,团队可以采取的最重要步骤之一是强制执行通用设计标准,以提高效率并改进其 API 程序的扩展性。
有许多不同的方法可以帮助团队设置和强制执行通用标准,包括使用 linter、风格验证引擎(其中许多是内部构建的),甚至是手动审查流程。在某些情况下,此审查流程可能涉及整个团队专门负责验证 API 设计或审查代码。
虽然这些方法在处理少量 API 时可能有效,但它们在大规模应用时效果不佳。事实上,当我们最近对一群 API 开发者进行调查,询问他们最希望在未来一年解决的 API 技术挑战时,标准化是排名第一的答案。
今天,我们很高兴在 SwaggerHub 中推出一项新功能,以帮助团队在组织级别设置和实施 API 标准:API 标准化。
API 标准化如何运作?
API 标准化有助于确保您在 SwaggerHub 中的 OpenAPI 定义符合贵公司的 API 风格指南。组织所有者可以选择各种规则来检查操作、参数和模型定义的合规性。这些规则可以应用于其组织内部开发的所有 API。
每次保存新版本的 API 时,SwaggerHub 都会自动验证该 API 是否符合标准。这意味着无论项目或团队如何,都可以在 API 设计过程的早期检测并修复不一致之处,从而避免在实际实现开发和上线后才发现问题。
将 API 标准化添加到您的工作流程中
SwaggerHub 旨在轻松融入您现有的 API 开发工作流程。如果您目前在 API 设计过程中使用一套现有标准,您可以在此处查看 SwaggerHub 是否支持这些规则。API 标准化还可以与我们强大的可复用域结构结合使用,后者让您可以使用可复用资产库在几分钟内创建新设计。

或者,如果一个团队正在通过“代码优先方法”中的构建或部署过程生成定义,则该定义可以推送到 SwaggerHub 并进行验证以满足组织要求,这在以前可能需要自己的流水线或流程。
虽然我们很高兴推出此功能,但这只是为团队和组织提供更高级功能的第一步。预计明年年初,API 标准化方面将有更多进展,以及更多旨在加速各种规模团队的 API 设计和开发过程的功能!
观看 API 标准化的实际操作
API 标准化在 SwaggerHub 的企业版计划中提供。
12月13日星期四,我们将举办一场免费培训,其中包括 SwaggerHub 中新 API 标准化功能的现场演示。本次网络研讨会,使用 Swagger 大规模构建和实施 API 标准,将探讨团队在设计大规模 API 时面临的挑战,并介绍组织可以采取哪些步骤来标准化 API 设计。
立即注册