API 治理最佳实践

作者: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 在哪里”的公司。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 文章、培训、教程等的电子邮件。 订阅

 

目录
© . All rights reserved.