建立有效的API治理需要正确理解其目标,但它究竟是什么呢?是定义标准或规则并应用它们吗?都不是。虽然这些是治理的一个重要手段,但这并非其最终目的。为了揭示API治理的真正目标,让我们探讨一下在适当地制定标准后能得到什么。
1. 从 API 混乱到一致性
API治理最显著的方面是定义设计标准,很多人认为这只是为了确保API之间具有一定程度的一致性,其实更重要的是评估它们的实际影响,我们来看看在没有有效标准时,设计师、开发者和提供商组织会遇到什么情况。
设计一个“搜索”的API操作可以有很多方法,如果没有共享的标准,两个设计师可能会花时间寻找如何设计“搜索客户”和“搜索产品”的操作方式,他们主要关注处理搜索过滤器、分页或如何对搜索结果列表进行建模。最后,在没有双方都能参考的标准下,这两个API操作将不具备相同的外观和行为特点,从而导致不一致。
当开发者使用“搜索客户”功能时,他们会分析该操作以弄清楚其工作原理。他们识别出诸如过滤器和分页处理方式或列表建模方式等设计模式,并据此编写代码。然后,在将调用“搜素产品”的功能集成到应用程序中时,由于尽管这两种操作都属于 “搜素”,但它们并未共享相同外观与行为特点, 因此需要再次执行以上步骤 。设计师之前学到的和编写的代码变得毫无用处,他们必须从头开始。这可能导致一些开发者选择不使用此类不一致的API,并寻找替代方案。
这种情况可能会出现在每个API的每个操作中。在提供商组织层面,交付并利用API将花费更多资金,阻碍组织推出新功能。如果API是公开的,那意味着收入减少。
因此,缺乏标准不仅导致了 API 间存在不一致性问题, 还对 API 设计师、消费者以及提供商组织财务产生了负面影响。
2. 给人赋能,并价值最大化
通过适当的API治理实施设计标准,其好处远不止于一致性,还包括:
预定义的设计方案使设计工作更轻松: 设计师可以专注于关键问题以及API需要解决的具体问题,而不是在常见功能上反复浪费精力和时间。
一致的设计模式使用户的工作更容易: 由于所有API调用都具有共同的外观和行为,因此将任何API调用集成到应用程序中变得简单快捷。这也让API更具吸引力。
有效的标准可以使提供商获益更多: 交付更多功能所需时间较短,愿意使用API 的客户数量增加,这都会带来更高收入。
真正了解 API 治理就是要让人们受益,并最大化 API 的价值。除了 API 设计和标准之外,API 治理还可以涵盖很多其他事物, 如 API 产品定义、安全性和实现等。它可以采取不同形式,如自动化、研讨会或培训课程等。建立 API 治理时, 必须牢记所有这些内容, 否则可能效果欠佳、完全无效或甚至适得其反。
Eolink Aoikit 分析统计报表,API 治理情况一览无余。针对 API 设置各类自定义标签,如 API 的开发状态、负责人等信息,系统会自动自动统计并生成报表,方便随时了解项目状况。无论你使用什么语言开发,都可以帮您统一规范地管理起来,并提供强大的文档管理、协作、测试、分享功能。
Eolink 翻译,原文《What is the purpose of API governance?》,作者:Arnaud Lauret