【API生命周期看护】API规划与定义

一、API规划与定义来源

对于一个API而言，什么时候是其生命周期的开始？
从一般意义上来说，云服务产品经理是负责API的规划与定义，所有的API都是从特定需求分解、规划而来的，因此需求分解阶段是API真正生命周期开始的地方。
这里原始需求一般可以是：

• 业务自身核心目标
• 行业方面的解决方案
• 外部客户的场景需求
• 体验点的自我改进

对于云服务产品经理而言，API维度主要需要负责规划、定义、体验以及竞争力的看护，详细来说：

• 需结合云服务的对接应用层面需求，定义云服务的API使用场景——API、组合关系、SDK等等；
• 需时刻对标友商，持续优化服务API的体验与竞争力；
• 需负责API的线上运营与生命周期管理，支撑客户对接集成，达成API生态目标；

最后，对于API的场景定义方法，我们一般遵循5W2H原则：

• Why：为什么要使用API，用户使用API的背景与价值；
• Who：哪些用户使用API，例如开发者、运维人员、测试人员等；
• What：哪些场景下使用API，例如应用开发场景、自动化运维场景等；
• Where：哪里使用API，例如Web官网、App、监控系统；
• When：什么时候使用API，例如开发环境部署、应用创建、应用运行、应用部署、应用运维阶段等；
• How：如何使用API，是通过直接调用、SDK还是CLI方式使用；
• How Much：有多少资源、多少业务量、多少调用量等；

二、规划流程

笔者并不是云服务产品经理角色，因此流程层面可能存在疏漏，内容仅供参考。

1、原始需求分解

当原始需求提交到产品经理侧时，产品经理会对需求进行判断、是否接纳，并根据需求内容进行分析，最终以Feature的形式呈现。
这里的Feature简单可以理解为“特性”，是服务一个个功能点的基础粒度划分。同时，服务的特性还能够以特性树的形式组织，这里不再赘述。

2、需求分类

当需求完成分解、落地为Feature后，特性本身也是支持进行分类的。这里，产品经理在完成分析后，会将对应的Feature类型划分为API类型。

3、接口规划与定义

在完成Feature类型的划分后，下一步就是需要正式为API进行相关定义了：

• 如果该特性已经存在相关接口，那么产品经理只需要从API设计平台中将接口关联到当前特性上即可；
• 如果还没有对应的接口能满足当前特性的需求，那么接下来产品经理就需要咨询架构师、并委托其进行专业的接口设计，在设计完成后关联API到特性之中。

三、评估方法

在指标维度层面，我们一般利用API关联的场景个数，以及API场景覆盖率来做衡量。

1、API关联场景个数

我们会通过服务API，反向查找、判断具体API关联的使用场景个数。这里的使用场景也就是指Feature数量，一般而言，数量越高，说明API使用场景越丰富。

2、API场景覆盖率

顾名思义，也即关联了场景的API个数占API总个数的百分比，一般应达到100%。

四、小结

虽然有一种观点认为，产品经理是很简单的一种角色，人人都能当。但是对于一个称职的云服务产品经理而言，仅从API的维度就有着重要的职责：不仅要对外部需求分析把关，还要有将外部需求抽象为API的能力。