
作者:Janet Wagner
越来越多的公司正在将 API 与应用程序和系统集成。根据 Cloud Elements 2018 年 API 集成状况报告,61% 的 API 行业专业人士认为 API 集成对其业务战略至关重要,57% 的人表示他们认为自己的组织是平台提供商。
对于积极部署 API 驱动业务战略的公司来说,治理是必要的。
治理对于拥有 API 设计程序或微服务架构的组织尤其有益。本文重点介绍了 API 治理的重要性,并介绍了一些 API 治理的最佳实践。
API 治理的主要目标:一致性
将自己视为平台提供商的公司数量正在增加,构建 API 和应用程序的公司数量也在增加。而且,一个组织越大,该公司可能会构建和使用的 API 数量就越多。组织构建的应用程序通常会使用内部和第三方 API。
正如我们在关于采用 API 优先方法构建产品的文章中所解释的那样,一致性是关键。治理流程可以帮助确保 API 在整个组织中保持一致。治理还可以帮助防止诸如重复代码、组件之间的紧密耦合、不可靠性和服务过多等问题。
您知道您的 API 在哪里吗?
API 布道师 Kin Lane 最近发表了一篇文章,讨论 API 治理,他在文中说,他经常遇到“甚至不知道他们所有 API 在哪里”的公司。Lane 建议,在您实施和维护 API 治理之前,您需要做一些事情。其中一些事情是了解您的 API 在哪里,清点您现有的 API,并创建一个组织结构图。
您需要先了解您在 API 方面的立场,然后才能计划您希望 API 的发展方向。
API 治理应包括哪些内容?
在您清点完 API 后,API 治理应该包括哪些内容?
1. 中心化
创建和执行策略的中心点。通常,会创建一个团队来处理整个组织的 API 治理。
2. API 合同
一些公司正在采用 API 优先的方法进行应用程序开发,我们将在另一篇博客文章中讨论。建立合同有助于确保 API 的一致性和可重用性。它还允许开发团队并行工作——团队可以创建模拟、测试和部署 API。
3. 样式指南
标准化 API 设计可确保组织构建的所有 API 保持一致。标准化 API 设计的一种方法是为所有 API 建立并执行样式指南。SwaggerHub 具有内置的样式验证,以便组织可以保持所有 API 的样式一致性。
4. 可重用性
标准化 API 设计不仅可以确保 API 在整个组织中保持一致,还可以包含可重用的组件。SwaggerHub 域可以帮助提高设计资源的可重用性。
5. 自动化
API 合同、文档和跟踪是可以自动化的过程,并且应该成为整体 API 治理的一部分。如今,有许多工具可以自动化 API 设计和治理流程。例如,SwaggerHub 提供了用于标准化设计样式和管理通用模型的工具。
6. 版本控制
版本控制可以帮助开发人员跟踪和维护不同版本的 API。您可以使用版本控制来弃用旧版本的 API,并用新版本替换它。内容协商是跟踪不同版本 API 的另一种方法。版本控制或内容协商可能取决于您的具体情况。
7. 弃用策略
版本控制可以有效地帮助简化 API 的弃用。一个有效的弃用策略可以使 API 的使用者受益,因为它提供了稳定性。开发人员将知道在 API 被弃用时会发生什么,您可以控制何时以及如何最终淘汰 API。
8. 跟踪
跟踪 API 的许多方面应该成为 API 治理的一部分。跟踪 API 的部署位置、谁在使用 API、API 的使用方式、路由信息以及 API 生命周期的其他要素。
9. API 发现
随着 API 和治理工具的数量不断增加,有必要提供一种方法来轻松搜索和发现已部署的 API 以及当前正在使用的工具。还需要一种描述依赖关系的方法,以便分析使用您的 API 的应用程序的未来影响。例如,Capital One 实施了服务发现门户,并启用了向该门户的自动发布功能。
那么,为什么要实施 API 治理?
API 治理有助于节省时间和金钱,因为它可以在 API 之间实现一致性,允许重用组件,并确保主动构建 API 以实现特定目标并为业务带来价值。API 治理还可以帮助公司做出有关 API 程序的明智决策,并建立构建、部署和使用 API 的最佳实践。
当组织中的每个人在 API 方面达成共识时,您的 API 程序将会更加高效、有价值和成功。
想要实施 API 治理策略?了解 SwaggerHub 如何提供帮助。
感谢您的阅读!正在寻找更多 API 资源?订阅 Swagger 新闻通讯。每月接收一封电子邮件,其中包含我们最好的 API 文章、培训、教程等等。订阅