简介
postman是谷歌推出的一款模拟API网络请求的工具,不仅方便接口的调试,而且加快前后端开发人员沟通交流.
优点
- 可以配置多个API请求环境,快速切换到不同环境进行数据请求
- 可以设置全局宏定义
- 可以设置环境变量宏定义
- 可以通过脚本对请求前后的数据进行校验
- 可以对请求进行归类集合,形成API文档(付费用户可以进行云端数据同步)
- 可以对每个参数添加描述,注释支持
markdown语法描述
安装
postman官网首页
点击官网链接,可以下载相应的安装包进行安装,支持[
MacOS,WIndows,Linux]等主流PC操作系统,安装方式不做过多描述.
主界面功能介绍
postman主界面
主界面按照功能大致可以划分为五个模块:
1. 侧边栏
侧边栏主要有三个功能:
- filter:主要是对History和Collections的检索功能
- History:每次进行请求的历史记录
- Collections:对请求进行归类集合,可以构建多级目录
如图所示:
Collections可以对请求进行归类并保存,可以作为API文档进行查看,方便前后端开发人员进行沟通.
2. API请求环境配置
功能点描述
- 请求的标签栏,一个标签代表一个请求
-
本次请求的环境选择,点击右边箭头可以进行不同环境的选择
环境切换 - 点击可以查看当前请求环境和全局环境的宏定义.
环境变量的宏定义查看
点击Edit可以对环境变量的宏定义进行增加和修改
环境变量宏定义编辑界面 - 点击
Manage Environment可以配置环境变量
Manage Environment
编辑请求环境
3. API请求构建及参数说明
请求构建
-
接口描述:在此注明此接口的使用方法,参数说明,已经注意事项等信息,支持
markdown语法 - 接口返回结果:如果有Examples()*括号中有值,代表此接口有返回结果的 示例(结果保存方式在下面介绍)
- 接口的请求方式:可以根据需要选择对应的请求方式,支持类型还是很多的
-
接口的
URL及Params:一般每个环境的URL是不变的,可以在环境变量中设置成宏定义,调用方式为{{api_url}}(两个大括号就能调出 并带有检索提示功能);比如设置的api_url在不同环境可以设置为不同的值,但是对应的key(api_url)是一样的.
| 请求环境 | key | value |
|---|---|---|
| 本地测试环境 | api_url | 192.168.199.123:80 |
| 外网测试环境 | api_url | www.ishuidi.com.cn/development |
| 外网发布环境 | api_url | www.ishuidi.com.cn/distribution |
-
参数的按钮:选择显示或者隐藏
请求体中携带的参数 - 发送请求:对本次构建的请求进行模拟,右边按钮可以选择发送请求并下载请求的结果
-
保存本次请求:对本次构建的请求进行归类整理,保存到侧边栏的
Collections,付费用户可以对数据进行云端同步 -
参数的设置
URL后面拼接的参数,例如截图中的access_token(本示例为post请求,参数应放在body中,在此只是为了说明需要),比如get请求体中如果带有参数,点击params会自动识别并显示参数的key和value;参数前面的选中按钮,可以控制本次请求是否带有此参数;在显示的参数后面有discripttion可以填写对此参数的描述;
4. API请求的二次构建和脚本处理
这部分主要是对请求的二次构建,主要有一下几个功能:
-
Authorization:设置鉴权参数，可以用OAuth之类的
鉴权方式 -
Headers:自定义HTTP Header,定义后台返回的数据格式,
比如json/xml
json数据格式定制 -
Body:post请求方式的参数,有四种形式可以选择，form-data主要用于上传文件。x-www-form-urlencoded是表单常用的格式。raw可以用来上传JSON数据
参数示例 Pre-request Script:在发起请求之前执行的脚本，比如参数中需要携带的时间戳,随机数等
Tests:在收到response之后执行的测试，比如对response的请求状态验证,对数据格式的校验等
//验证请求的状态码
tests["code is correct"] = responseCode.code === 200;
//json数据解析
var data = JSON.parse(responseBody);
//获取返回数据中的token并设置为环境变量
postman.setEnvironmentVariable("access_token", data.data.access.token);
//获取返回数据中的user_id并设置为环境变量
postman.setEnvironmentVariable("user_id", data.data.user.user_id);
5. API请求结果查看
这部分主要是对请求结果的查看,主要有一下几个功能(对应第四部分的相应功能):
-
body:返回数据的格式，Pretty可以看到格式化后的数据(有
json/xml等多个选择)，Raw就是未经处理的数据，Preview可以预览HTML页面
格式化返回数据 Cookies:返回的结果中是否有Cookies
-
Headers:后端返回数据的格式
-
Tests:第四部分中的
Tests脚本执行结果
脚本正确执行
关于利用
postman进行测试,或者数据校验后期补充,主要用到的是javascript语法
