产品经理如何读懂API文档吗？

或许很多产品经理和我有一样的疑惑？产品经理到底需不需要会阅读API的文档。答案当然是肯定的。

做产品这么久以来，之前也能看得懂API文档，但却没有真正去分解API文档到底包含哪些？会阅读API又会给产品经理带来哪些好处？

一、什么是API？

API：应用程序接口（API：Application Program Interface），是一组定义、程序及协议的集合，通过 API 接口实现计算机软件之间的相互通信。

例如“USB接口”，就是用来传输数据与存储数据的。

再比如，产品要实现登陆的功能，后端开发工程师就会定义并提供一个登陆的接口，而前端人员只需要按照既定规则请求接口即可，不需要理解接口内部的功能具体是怎么实现的。从这样的定义来看的话，接口使得开发之间的协作会变得方便。

所以，我们可以简单地认为“接口定义了功能”。

二、API文档结构

通常来说，一份API接口文档包含多个API单个信息，单个API的信息包含以下信息：

1、接口描述：这个接口是用来干嘛的，以及相关的规则

2、接口地址：以网址的形式展现，你通过发送请求给这个网址来对接口进行交互操作

3、请求方法：常用的有post和get两种方式，一个是读接口(常用get)一个是写接口(常用post)

4、请求参数：请求该接口时，需要提供的参数，参数属性包括名称、类型、是否必填、描述等

5、权限说明：接口访问的权限（例如功能型或数据型）。

6、返回参数：接口正常响应后，返回的内容

7、错误代码：接口请求失败后，返回的错误代码

企业微信开放平台接口文档

三、阅读API文档的好处

1、对技术理解更深刻，培养自己的技术理解能力。

我在写这篇文章，其实也增加对API接口及技术的理解。

在产品日常工作中针对具体业务API文档时，若认真仔细阅读完之后，对所需要的字段，对后端与前端及与第三方接口之间协作，同时他们之间交换了哪些信息，交互的结果都是非常清楚的。

2、更好的评估产品开发工作量

产品经理很容易蒙的就是开发工作量。开发跟你说一个开发周期，你感觉不需要这么多时间，但又不说明不了为什么不需要这么多时间。

而如果你能阅读接口文档，其实也能大体明白，后端大概需要开发多少个接口，哪些是复用的，哪些是需要单独开发的。一定程度可以帮助产品经理评估开发工作量。当然你非常熟悉的前提下，也可以直接和开发说，哪些接口是可共用的，不用重新写。

3、锻炼产品的抽象能力

接口本身就是面向对象的抽离，而一个产品也是有若干个功能的集合。这时候你就可以很好的将产品进行抽象出来。

比如我之前做的采购平台。人员管理有人员详情，客户权限需要获取当前机构的人员信息，其实这2个接口都可以共用，不需要分别单独开发。

再多说一句，不仅接口可以共用，前端页面的组建都可以抽象出来，再设计原型的时候都可以考虑页面的共用性。

and

---

我是余小智 。产品经理、创业者，

被简书称为“90后最会写故事的撰稿人”。