
API治理的最佳实践
有越来越多的公司将 API 与应用程序和系统集成,根据 Cloud Elements 2018 API 集成状况报告,受访的 API 领域专业人士 61%认为 API 集成对其业务至关重要,57%表示他们把自己的组织看作 API 平台提供商。
对于积极部署 API 驱动的业务策略的公司,API 治理是必需品。
治理对拥有 API 设计或微服务体系结构的组织特别有益,本文解释了为什么 API 治理如此重要,并介绍了一些最佳实践。
一、API 治理的主要目标:一致性
认为自己是平台提供商的公司数量正在增加,构建 API 和应用程序的公司数量也在增加。随着组织规模的扩大,该公司可能会构建和使用更多的 API。组织构建的应用程序通常同时使用内部 API 和第三方 API。
一致性至关重要,治理流程可以确保整个组织中的 API 是一致的。治理还可以帮助防止诸如重复代码、组件之间紧密耦合、不可靠性和过多服务等问题。
你知道你的 API 在哪里吗?
API 传道者 Kin Lane 说他经常遇到“甚至不知道自己所有 API 在哪里”的公司,他建议在实施和维护 API 治理之前,需要做很多事情,其中包括:
-
知道你的 API 在哪里
-
对现有的 API 进行清单记录
-
创建一个组织结构图
在计划如何使用你的 API 之前,首先需要了解你目前所处位置上关于 APIs的情况。
二、那么为什么要实施 API 治理?
API 治理有助于节省成本,因为它可以在 API 之间实现一致性,允许组件被重复使用,并确保 API 是积极构建的,以实现特定目标并为业务带来价值。 API 治理还有助于公司就 API 计划做出明智决策,并建立构建、部署和使用 API 的最佳实践。
当组织中每个人都对 API 达成共识时,您的 API 计划将更加高效、有价值和成功。
三、API 治理应包括什么?
一旦梳理了自己的 API,那么 API 治理应该包括什么呢?
-
集中化
创建和执行政策的中心点。通常会创建一个团队来负责整个组织的 API 治理。一些公司正在采用面向应用程序开发的 API First方法,建立合同有助于确保 API 是一致且可重复使用的。它还允许开发团队并行工作- 团队可以创建模拟、测试和部署 API。
-
样式指南
标准化 API 设计确保组织构建的所有 API 都保持一致。规范化 API 设计的方法之一是为所有 API 建立和强制执行样式指南。
-
可重用性
标准化 API 设计不仅确保组织内的 API 一致,而且包含可重用的组件。
-
自动化
API 合同、文档和跟踪是可以自动化的过程,并应成为整体 API 治理的一部分。今天有许多工具可自动化 API 设计和治理流程。
-
版本控制
版本控制有助于开发人员跟踪并维护不同版本的 API。您可以使用版本控制来废弃旧版 API 并替换为新版。内容协商是另一种跟踪不同版本 API 的方法。根据您特定情况,版本控制或内容协商都可能适用。
-
废弃政策
版本控制有效地帮助简化废弃 API 的过程。有效的废弃政策有利于 API 的使用者,因为它提供了稳定性。开发人员将知道在 API 被废弃时会发生什么,并且您可以控制何时以及如何最终停用 API。
-
跟踪
跟踪 API 的许多方面应该成为您的 API 治理的一部分。跟踪已部署的 API、谁在使用这些 API、如何使用这些 API、路由信息和其他元素都是 API 生命周期中必要的。
-
API 发现
随着越来越多的 API 和治理工具出现,提供一种易于搜索和发现已部署 API 和当前正在使用工具集合方法变得必要。还需要一种描述依赖关系并分析消费您 APIs 的应用程序未来影响所需方法。
小结
总的来说,通过API治理,可以更好地管理数字资产,创造更多的价值。
Eolink编译
原文:Best Practices in API Governance,By Janet Wagner
https://swagger.io/resources/articles/best-practices-in-api-governance/
更多推荐
所有评论(0)