接口文档怎么看（接口参考文档怎么写）
本文目录
接口参考文档怎么写
一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。
推荐使用的是docway 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。
一、请求参数
1. 请求方法
GET
POST
PUT
DELETE
其他
application/x-www-form-urlencoded
application/json
application/xml
multipart/form-data
用于获取数据
用于更新数据，可与PUT互换，语义上PUT支持幂等
用于新增数据，可与POST互换，语义上PUT支持幂等
用于删除数据
其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS
2. URL
url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。
3. HTTP Header
HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。
常用的content-type：
请求参数使用“&”符号连接。
内容为json格式
内容为xml格式
内容为多个数据组成，有分隔符隔开
4. HTTP Body
描述
程序员怎样规范编写接口文档
规范的事情当然要有专业的工具。推荐使用的是docway 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。
一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。
一、请求参数
1. 请求方法
GET
POST
PUT
DELETE
其他
application/x-www-form-urlencoded
application/json
application/xml
multipart/form-data
用于获取数据
用于更新数据，可与PUT互换，语义上PUT支持幂等
用于新增数据，可与POST互换，语义上PUT支持幂等
用于删除数据
其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS
2. URL
url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。
3. HTTP Header
HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。
常用的content-type：
请求参数使用“&”符号连接。
内容为json格式
内容为xml格式
内容为多个数据组成，有分隔符隔开
4. HTTP Body
描述
怎么看懂下面的额接口文档，然后在postman里输入
在电脑桌面上找到安装的postman软件位置，鼠标双击图标打开；打开后显示如下界面即为打开成功。现在我们开始对一个接口进行测试
请点击输入图片描述
点击左上角的“+New”，在打开的弹窗页面中切换到creatNew页面（一般打开后默认就是creatNew页面），鼠标点击Collection，新建一个集合，这个集合就类似于一个文件夹，我们可以把一个项目或者一个完成功能的所有接口都放在它的里面。
请点击输入图片描述
在新打开的弹窗页面creat a new collection中，输入你想要给这个collection起的名字，然后再下方的description中添加描述说明，这个非必填项，所以可以忽略不写，直接点击右下角的“creat”进行确定。
请点击输入图片描述
选中刚刚建的collection，鼠标右击，在打开的菜单栏中选择“add request”，会进入下面的页面，输入这个接口请求的名称，同样可以在下方的description中添加描述说明，点击Save进行保存
请点击输入图片描述
按照接口文档中的描述，输入接口请求的url，添加请求头和请求体，点击运行，就完成了一个接口的测试。
请点击输入图片描述
如何使用接口文档，查出相对应的信息 php
微信接口举例：
获取关注者信息接口
1、接口使用说明
//获取用户基本信息public function get_user_info($openid){
$url = “
$this-》access_token.“&openid=“.$openid.“&lang=zh_CN“;
$res = $this-》
具体接口详情（微信公众号开发者文档）http://mp.weixin.qq.com/wiki/1/8a5ce6257f1d3b2afb20f83e72b72ce9.html 获取用户基本信息接口
规范的接口文档中，都包含那些信息
一般一个规范的接口文档至少包含三部分信息，分别是基本信息，请求参数部分，响应部分
基本部分又包括接口名称，接口URL，请求方法以及描述信息；
请求参数部分主要包括请求头和请求体部分，主要是对这两个部分的每个字段定义的说明和解释
响应部分主要包括响应返回的数据类型，已经响应数据中每个字段的含义 。
以前在黑马程序员培训后，也会买他们出版的书，这个就是直接从书上看的。现在很多大学都用的他们的教材，我就会没事看看。反正说的挺详细的。
更多文章：
majority of（the majority of 和 a majority of的区别以及用法例句）
2026年10月11日 07:40
2026年10月11日 07:20
2026年10月11日 06:30
2026年10月11日 06:20
2026年10月11日 05:40
another time（another time和other time的区别）
2026年10月11日 05:00
2026年10月11日 04:50
2026年10月11日 03:00
2026年10月11日 02:40
2026年10月11日 02:20
