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 团队完成 API 设计任务非常重要。他们应该拥有可用的工具(例如,自动检查是否符合指南的 API 验证工具),这意味着实际的 API 审查可以专注于有趣的问题,而不必花时间进行相对机械的可自动化检查。

扩展 API 评论

API 审核的总体思路相对简单,但确保审核流程可扩展也很重要。它不应该成为API设计和开发过程中的瓶颈。可以采取哪些措施来扩大审查流程?

  • 制定一份清单,团队可以使用该清单来确保他们完成进入 API 审核所需的所有任务。
  • 提供可供团队轻松重用的标准化构建块。这些模式应该是许多 API 设计的一部分(常见的例子是如何进行分页或如何表示错误消息)。

确保仅在所有利益相关者都在场的情况下进行 API 审查也很重要。有效地安排审核且不积压意味着审核参与者的角色必须明确定义,并且担任这些角色的人员将审核视为 API 旅程中有价值的一步,而不是他们希望的强制步骤避免。

确保团队接受审核流程的一个重要方面是开发并不断完善任务尽可能自动化的方式,以便审核可以专注于讨论 API 设计的有趣方面。

快速发布审核结果也很重要:API 是否有任何更改?如果是,为什么以及我们可以从这些变化中学到什么?API 审核流程是否会因此次特定审核而发生变化?

API 评论是 API 设计协会反馈的核心要素。您的组织可能对该组有不同的名称,但拥有一组编译和管理 API 设计方式的组织模式和实践的人员非常重要。

API 设计协会可以讨论审查过程中提出的问题,并且他们应该决定如何更改模式和实践。

结论

API 审核在 API 生命周期中发挥着重要作用。它们对于 API 团队非常重要,这样他们就可以创建一个非常适合 API 环境的可用 API。它们也是一种重要的协作机制,可确保 API 设计模式和实践在整个组织内共享和发展。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

wouderw

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值