专注于 API 的团队不断寻求提高其开发工作流程中交付新功能和更新功能的速度。在 API 设计方面,团队可以采取的最重要步骤之一来提高效率和 API 计划的可扩展性是强制执行通用设计标准。
有许多不同的方法用于帮助团队设置和强制执行通用标准,包括使用 linters、样式验证引擎(其中许多是内部构建的)甚至手动审查流程。在某些情况下,此审查过程可能涉及整个团队致力于验证 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 设计的步骤。
立即注册