产品经理理解接口文档（产品经理需要懂得的it入门干货）

接口文档怎么看？其实公司大多数用的都是内部接口，第三方接口其实相比起来用得少，两者区别只是提供方不一样。

接口文档其实就是一个讲解某个接口是做什么的文件。不管是你们公司内部的开发，或者是你跟一些第三方合作的时候，产品经理必须要知道怎么看接口文档，知道里面哪些部分是重要的才行。

否则别说功能实现，沟通都很难进行……

懂点基础知识好沟通

比方说，你们公司要做一个考勤系统，想用人脸识别来进行打卡，但是人脸识别这个事可能有点技术难度，我们就决定用第三方了。

找到第三方，第三方可能会丢你一个接口文档让你自己看去

这时你就要通过看文档了解这个接口提供哪些功能，你需要用到哪些，你的哪些想法是他的接口能满足的，哪些是不能满足的。

比方说，现在有一种情况，大家现在经常戴口罩或者是戴墨镜什么的。这个api接口提供的人脸识别的打卡功能里面，人戴上的这种戴上眼睛之后，能不能进行打卡，就需要在他的文档里面去找到，看是否有相应能力。

研发也是要写很多东西的~比如接口文档

先介绍几个概念：

请求参数

比方说你需要让阿里云给你发一条短信，你至少需要告诉他你要发送到哪个手机上面去，对吧？这个手机号码就是请求参数。在请求接口的时候，需要把这个请求参数给他。

请求参数跟设计功能很相关的，必须在产品设计的时候考虑如何这些请求参数，检查接口文档的时候也要重点留心各种请求参数是不是都写全了。

跟请求参数相对应的是返回参数

请求做完了之后，它要告诉你他有没有发送成功，成功了就返回查询的信息，失败的就报错。比如说你是一个查询订单详情的，或者查询一个商品页，接口就需要把商品查询出来商品的关键信息之类的返回给你，这个就是返回参数。一般在工作中关注“返回参数”比较多。

这时一般都会返回多个字段，但是我们在接口文档里面就需要知道它字段代表什么意思，比如参数名是什么，类型是什么；如果出现错误的话，它会有一些错误码给你。比方说你在下一个微信支付订单的时候，前端在调用的时候就返回了一个403的一个错误，然后这个时候对照接口文档一看你就知道403代表什么意思了。

接口文档可以是word、txt等等，形式不重要，关键是文档里面最关键的7个步骤需要好好了解一下：

1.接口描述：简述接口是干什么的

2.接口地址是什么？

接口暴露出去给别人用，一定是有一个地址的。一定要知道请求地址是什么，这也就是请求的URL是什么。

3.调用时的方法类型是什么

是pose的还是get，都会在这个文章里面描述好。

post的和get的区别是什么？在get请求传输的时候，URL地址会在网址的后面附加上去，也就是说网址上会有请求参数，并且get请求的参数是有长度限制的；post请求的参数就不会在URL里面展示出来。

4&5.请求参数、返回参数

6.返回结果

7.错误代码

【怼研发环节】

跟研发提需求的时候，研发可能直接告诉你不行，这个需求做不了，是不是？这个时候你可以告诉他，某某某的接口里面提供这个功能，我们就需要调用它的接口就可以了，然后你把接口给他，就可以了。

使用ApiPost工具可以实现调用接口，知道这个接口它是否是正常的，还有这个接口返回的数据和传入的参数是什么。

apipost = API接口调试工具 接口文档管理工具 Mock 工具

其实我们使用第三方接口的时候，开发人员其实不是直接用第三方接口的，而是先由服务端的人员把第三方的接口进行了封装之后再提供出来的。

我最近是要上线一个输入电话号码发送短信的功能，这个功能就需要考虑到接口要进行请求次数的限制，否则可能有的人会无聊地不停的请求发送短信，可能很快公司短信这一块的经费就消耗完了……