做产品经理的难免会调研各式各样的第三方需求能力。以满足产品提供用户的市场价值，比如第三方登录、图像识别、风控算法，都有专注的服务厂商。
企业无需自己花时间和精力投入在具有较高技术壁垒或时间成本的需求上。简单称之为：“就算自己做也做不好”
同样接口也允许数据产生了流转，可以让部门之间、企业之间有权限、数据共享的意义。
学会看API接口文档，是一项产品经理的基本功。
接口文档包含什么维度？
▲ 接口文档范围
有了接口文档，我们可以知道功能的逻辑、功能的边界、和接入的条件。比如要
▲ 万年历的能力描述
接口文档的编写规范
每家公司每个项目组的文档都可能不一样。一般是项目成员的前后端开发工程师定义接口，接口文档需要不断维护。
所以经常有不懂开发的老板和产品经理说，某某后台同学你把后台功能给其他部门直接用、或者某某客户端你把你的app直接给某某部门后台用。
“开发的拳头就捏紧了。”
在一家公司不同项目下，接口仍然有规范不一致的情况，更何况公司之间的数据交流。这也是为什么有产品经理的公司，都不会选择外包。外包开发意味着后期维护在接口、规范上都是不清楚的，难以搞清楚对方的撰写代码思路和潜在问题。
接口规范集中在4点维度上去做规范
新增post
修改put
删除（delete）
获取（get）
通过上面4个定义接口的权限。
2.URI定义
以/a开头，如果你的账户涉及到需要登录权限、比如我们的微信开放平台、第三方单点登录，则需要/u。如果是通过后台要查询数据库列表，则以/search结尾。如果是查询前台的列表则以/list结婚
3.请求参数和返回参数
两个类型参数都分为5列：字段、说明、类型、备注、是否必填。
▲ 接口的参数案例
字段：类的属性
说明：中文解释字段什么意思
类：属性类型
有string（字符串）、number（整数）、object（对象）、arrar（数组）四种类型。
备注：接口的能力或逻辑解释，或者可以写一下列子，有的情况有列子会让开发人员看得懂一些。比如json
返回参数：返回参数和产品经理的异常是非常相关的。比如
只会返回接口调用成功或失败
返回某些参数
返回列表
上面3种返回形式都包含内容有区别。
第一种
新增、删除、修改等，只需要一个结果即可。
第二种
结构体有2个，第一个是code/mesaeg/dat ，第二个是data里写返回的参数，data是object类型
第三种
过于偏向开发知识，就不再叙述。
接口文档主要有什么
▲ 喜马拉雅接口文档
请求后会有响应。在代码层面会有如下的显示规则
serid Long 用户ID
usernick String 用户登录名
sessionkey String 用户会话key
示例
请求
“XXXX”
响应
{“usersession11”:
{“userid”:”12512313”,
“usernck”:” name1 “,
”sessionkey”:”2122323232332435353”,
}}
响应有结果，并且显示调用成功则表示接口调通。
开放平台文档字段说明
第一：请求
说明请求地址，告诉如何调用接口
第二：调用秘钥
比如喜马拉雅要求申请秘钥，走开放平台账户协议进行注册。
第三：API测试
接通后倒地显示什么结果，如何知道接口是否接通？就需要在接口文档里面知道成功的参数
▲ 请求测试
同理可以在微信开放平台上可以看到
▲ 微信开放平台的接口文档描述
多个接口文档组成的接口目录让产品经理和开发者快速查询功能点，以集成到自己的产品中。所以产品经理做第三方能力调研，最多时间的就是去看对方的接口文档就
包括对接口的描述，比如下图是是地理位置获取。可以看到在该接口下，是智能收到应用没有停止下的消息接收。
▲ 微信公众平台提供位置信息的接口
以上就是本次分享，今天的分享就在这里。
每天体验1款APP圈子
联系客服
