做产品总监的难免会督查各式各样的第三方需求能力。以满足产品提供用户的市场价值，比如第三方登陆、图像辨识、风控算法，都有专注的服务厂商。
企业无需自己花时间和精力投入在具有较高技术壁垒或时间成本的需求上。简单称之为：“就算自己做也做不好”
同样插口也容许数据形成了流转，可以让部门之间、企业之间有权限、数据共享的意义。
学会看API接口文档，是一项产品总监的基本功。
接口文档包含哪些维度？
▲ 接口文档范围
有了插口文档，我们可以晓得功能的逻辑、功能的边界、和接入的条件。比如要
比如有万年历的插口文档描述了插口的传输数据是当日详情。
▲ 万年历的能力描述
每家公司每位项目组的文档都可能不一样。一般是项目成员的前前端开发工程师定义插口，接口文档须要不断维护。
所以常常有不懂开发的老总和产品总监说，某某后台朋友你把后台功能给其他部门直接用、或者某甲客户端你把你的app直接给某甲部门后台用。
“开发的拳头就捏紧了。”
在一家公司不同项目下，接口依然有规范不一致的情况，更何况公司之间的数据交流。这也是为何有产品总监的公司，都不会选择外包。外包开发意味着后期维护在插口、规范上都是不清楚的，难以搞清楚对方的撰写代码思路和潜在问题。
1.接口方式
新增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类型
第三种
过于偏向开发知识，就不再表述。
互联网企业要开放能力给其公司或开发者使用，就须要创建插口和订制插口规范。
常见的产品形态有开放平台这类方式。通过开发者注册帐户，创建单独密钥，再提供插口容许开发者获取能力。
如下是喜马拉雅的开放平台下提供的音频能力的SDK、API接入文档。在插口文档上面有上面提及的规范内容。
▲ 喜马拉雅插口文档
请求后会有响应。在代码层面会有如下的显示规则
serid Long 用户ID
usernick String 用户登陆名
sessionkey String 用户会话key
示例
请求
“XXXX”
响应
{“usersession11”:
{“userid”:”12512313”,
“usernck”:” name1 “,
”sessionkey”:”2122323232332435353”,
}}
响应有结果，并且显示调用成功则表示插口调通。
第一：请求
说明恳求地址，告诉怎么调用插口
第二：调用密钥
比如喜马拉雅要求申请密钥，走开放平台帐户合同进行注册。
第三：API测试
接通后摔倒显示哪些结果，如何晓得插口是否接通？就须要在插口文档上面晓得成功的参数
▲ 请求测试
同理可以在微信开放平台上可以看见
▲ 微信开放平台的插口文档描述
多个插口文档组成的插口目录让产品总监和开发者快速查询功能点，以集成到自己的产品中。所以产品总监做第三方能力督查，最多时间的就是去看对方的插口文档就
包括对插口的描述，比如下图是是地理位置获取。可以看见在该插口下，是智能收到应用没有停止下的消息接收。
▲ 微信公众平台提供位置信息的插口
