3.postman与接口文档_postman生成接口文档

数据接口简称接口，是被请求的url地址

目录

1  postman

1.1  下载

1.2  创建工作站

1.3 请求 

1.3.1  工作站中创建请求

1.3.2  带查询字符串的请求

1.3.3 默认带参数的post请求

1.3.4  发送JSON的请求

1.3.5  发送带Authorization请求头的请求

1.4  删除工作站

1.5  整理请求

1.5.1 创建组

1.5.2 删除组 

1.5.3  在组中添加请求 

1.5.4  将写好的请求保存到组中

2  接口文档

---

1  postman

postman是接口测试工具，接口测试工具是用来模拟请求的，postman官网 Postman

1.1  下载

点开后会出现一个页面让你登录，登录之后就能用了

1.2  创建工作站

1.3 请求 

1.3.1  工作站中创建请求

点击之后选择请求方式，输入你要访问的路由与要发送的数据，点击send后，在最下方会显示响应内容

1.3.2  带查询字符串的请求

• post请求也可以带查询字符串请求

1.3.3 默认带参数的post请求

如果用post发送数据就要在Body中的x-www-form-urlencoded中填写数据

• x-www-form-urlencoded是post默认的Content-Type

1.3.4  发送JSON的请求

1.3.5  发送带Authorization请求头的请求

在我们使用token的时候会使用到请求头 Authorization

使用Bearer Token不用把Bearer写在Token内容的开头

或者也可以放在 Headers 中发，在 Headers 中发就需要带Bearer 了

1.4  删除工作站

点击左上角可以查看我们当前已有的工作站

我们现在想把test这个工作站删掉，那么我们首先进入test工作站

点击Workspace Settings

点击Delete Workspace

输入工作站的名字，然后点击删除

这样test工作站就没有了

1.5  整理请求

当要测试一个项目的时候，接口量比较大，如果都堆在顶部会很不方便，这个时候我们可以使用collections功能

1.5.1 创建组

这样可以建立一个请求组，在铅笔图标的位置可以修改名字

1.5.2 删除组 

这样是删除这个组

1.5.3  在组中添加请求 

点击这里可以添加请求

可以在这里修改名字

1.5.4  将写好的请求保存到组中

之前通过加号添加的请求，想添加的组中，点击这里的save

选择要保存到的组

2  接口文档

接口文档是接口的说明文档，接口文档应该包含

• 接口名称
• 接口url
• 调用方式 像GET、POST这些
• 参数格式 包含参数名称，参数类型，是否必选，参数说明
• 响应格式 接口的返回值情况，包含数据名称，数据类型，说明
• 返回示例

这个是接口文档的样子

这个是接口文档的md文件内容

# 图书列表
- 接口URL : http://www.liulongbin.top:3006/api/getbooks
- 调用方式 : GET
- 参数格式: 
 
|参数名称|参数类型|是否必选|参数说明|
|:----    |:---|:----- |-----   |
|id|Number|否|图书id|
|bookname|String|否|图书名称|
|author|String|否|作者|
|publisher|String|否|出版社|
- 响应格式: 
 
|数据名称|数据类型|说明|
|:----    |:---|:----- |
|status|Number|200成功;500失败|
|msg|String|对status字段的详细说明|
|data|Array|图书列表|
|+id|Number|图书id|
|+bookname|String|图书名称|
|+author|String|作者|
|+publisher|String|出版社|
- 返回示例 
 
``` 
{
    "status": 200,
    "msg": "获取图书列表成功",
    "data": [
        {
            "id": 1,
            "bookname": "西游记",
            "author": "吴承恩",
            "publisher": "北京图书出版社"
        },
        {
            "id": 2,
            "bookname": "红楼梦",
            "author": "曹雪芹",
            "publisher": "上海图书出版社"
        },
        {
            "id": 3,
            "bookname": "三国演义",
            "author": "罗贯中",
            "publisher": "北京图书出版社"
        }
    ]
}
```