https|产品必修课：接口文档怎么用？( 二 ) it|mhz|ryan|英特尔|ghz|ks|睿频|英

当然啦，接口文档还有很多妙用，比如作为撕逼利器、装逼神器等等，欢迎大家在留言区写下你的文档故事~
三、接口文档怎么看？接口文档有这么多好处，那我们怎么去读懂它呢？在这里我们用微信订阅通知的接口文档作为学习材料。

文章插图

文章插图
如上图所示，接口通常分为四部分：请求方法、url、请求参数、返回参数：
1）请求方法：常用的方法就是下面的四种——GET、PUT、POST、DELETE。

GET请求会向数据库发索取数据的请求，从而来获取信息。该请求就像数据库的select操作一样，只是用来查询一下数据，不会修改、增加数据，不会影响资源的内容，即该请求不会产生副作用。
与GET不同的是，PUT请求是向服务器端发送数据的，从而改变信息。该请求就像数据库的update操作一样，用来修改数据的内容，但是不会增加数据的种类等。
POST请求同PUT请求类似，都是向服务器端发送数据的，但是该请求会改变数据的种类等资源，就像数据库的insert操作一样，会创建新的内容。目前所有的提交操作几乎都是用POST请求。
DELETE请求顾名思义，就是用来删除某一个资源的，该请求就像数据库的delete操作。

这个概念产品经理简单了解即可，一般不考
2）url：以微信微信订阅通知接口的url为例https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate?access_token=ACCESS_TOKEN
我们可以把这个 URL 分解成 5部分：

协议部分：指访问服务器获取资源时，需要使用哪种协议。常用的有http、https、ftp协议等。本例中的为https。
域名部分：指资源宿主服务器的主机名或IP地址。本例中的域名部分为：api.weixin.qq.com。URL中也可以使用IP作为域名。
端口部分：域名和端口之间使用“:“作为分隔符，端口不是一个URL必须的部分。http服务的默认端口是80，这种情况下端口号可以省略，如果使用了其他端口必须知名，例如：http://www.azhai.com:90/。
虚拟目录部分：该部分说明了资源位于服务器的什么地方。从域名后的第一个“/“开始到最后一个“/“为止，是虚拟目录部分。本例中的虚拟目录是“/wxaapi/newtmpl/”。
文件名部分：从域名的最后一个”/“开始到”?“为止，是文件名部分。如果没有”?“，则是从域名后的最后一个“/”开始到“#”为止；如果没有“？”和“#”，那么从域名后的最后一个“/”开始到结束，都是文件名部分。文件名部分也不是一个URL必须的部分，如果省略该部分，则使用默认的文件名。本例中的文件名是“addtemplate”。

同样，产品经理不需要非常明白。
3）请求参数和返回参数：请求参数和返回参数都分为：字段、说明、类型、默认值、是否必填这5列。

文章插图
字段：类的属性
说明：中文释义
类型：属性的类型，只有String、Number、Object、Array四大类
备注：一些解释语，或者写简单的示例
4）返回参数，要分两种情况讨论：
只返回接口调用成功或者失败：code、reason
返回参数：字段、说明、类型、默认值、是否必填
四、一些可供学习的网址微信开放文档
https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html
金融交易统一接入平台
https://ufx.hs.net/
高德地图API
http://lbs.amap.com/api/jsapi-v2/summary
作者：阿宅的产品笔记；公众号：阿宅的产品笔记（PMZZnote）