Postman 使用
当前使用postman版本:10.24.7
Postman可以创建多个工作空间 workspace,每个workspace都是个独立的空间,workspace内功能由 Environments、Collections组成使用。Environments默认有全局变量 Globals,这个下面变量Variable是在整个工作空间 workspace下生效的,除此之外还可以根据自己有多少环境相应的环境变量,Globals和自定义的环境下Variable可以相同,自定义环境切换到哪个就使用哪个环境里面的值,但环境里的变量是会覆盖Globals内的同名变量的,所以Globals内放置的都是全局公用的变量,多个环境内变化的变量才会放到自定义环境内
创建workspace
删除workspace
创建Collection与request
环境变量 Environments
使用环境变量传递数据
这里以token使用为例,正常每个请求都需要附带token
才能进行请求,当掉用登录接口后,拿到token
填入header
中的Authorization
进行下一步掉用,如果有特别多接口就非常不方便了,这里就可以将登录后拿到的accessToken
和refreshToken
放到环境变量中,其他地方直接使用变量填入响应的值,这里是使用Tests功能,它允许在发送请求后自动执行一些测试,并对服务器返回的响应进行验证
这里不止环境变量,Globals变量、集合变量也是可以用于Tests脚本设置的
js
pm.globals.set("variableName", value); // 设置全局变量
pm.collectionVariables.set('variableName', value) // 设置集合变量
pm.variables.set("variableName", value); // 设置局部变量
// 局部变量或临时变量非常适合存储仅在当前请求或脚本执行期间需要的数据。不会被永久保存在 Postman中,也不会对其他请求或环境产生影响
至于获取token这里,不止使用Tests来设置,使用Pre-request Script也是可以的,不过这里需要使用js编写完整的登录请求获取结果再设置环境变量,postman里不能在Pre-request Script直接调用现有的登录接口
如果使用Pre-request Script,可以在集合上面来设置预运行脚本,这样集合下面的每个请求都会在发送请求前运行集合上的Pre-request Script脚步
js
const d = new Date();
const t = d.getTime();
const lastRefreshTokenTime = parseInt(pm.environment.get("lastRefreshTokenTime"));
// 时间超过一个小时就重新登录刷新token
if (t-lastRefreshTokenTime < 3600000) {
return
}
const url = pm.globals.replaceIn("{{transportProtocol}}://{{host}}:{{port}}/user/login")
const req = {
url: url,
method: 'POST',
header: {
'Content-Type': 'application/json'
},
body: {
mode: 'raw',
raw: JSON.stringify({
username: pm.globals.get('account'),
password: pm.globals.get('password')
})
}
};
pm.sendRequest(req, function (err, response) {
// 这里状态码判断逻辑根据实际修改
if (response.code === 201) {
const data = response.json()
pm.environment.set('TOKEN', data.data.accessToken)
pm.environment.set('REFRESH_TOKEN', data.data.accessToken)
return
}
console.log(`Error: ${JSON.stringify(response.json())}`)
});
Pre-request Script与Tests使用场景
Pre-request Script会在请求发送前先执行,所以可以在这里调用其他接口,将数据添加到请求参数、headers里面,还可以在请求前根据请求生成验签数据等操作
Tests是在请求完成后才执行的,这时可以通过
pm.response
拿到请求结果数据了,所以就可以将部分数据存储到变量中用于其他接口使用,也可以对请求结果做断言测试
js
// 请求前设置header参数
pm.request.headers.add({key:'X-SIGNATURE',value:XSIGNATURE});
// 获取请求前headers、请求方式、params、body、url。这些数据都在 pm.request 里面可以获取到
// 注意有些值是以数组的类型存储的,不过postman应该对这些数组做了修改,像.length、.forEach等函数是不能使用的
const headers = pm.request.header
const httpMethod = pm.request.method
// 注意body的数据格式 { mode: 'raw', raw: { pageIndex: 0, pageSize: 10, }, options: { raw: { language: 'json' } }, };
const body = pm.request.body
// pm.request.url 包含内了protocol、path、host、query等数据按需取用即可
const query = pm.request.url.query
const protocol = pm.request.url.protocol
const path = pm.request.url.path
const host = pm.request.url.host
// 获取响应状态码
const responseCode = pm.response.code;
// 获取响应头
const responseHeaders = pm.response.headers;
// 获取响应体
const responseBody = pm.response.text();
// 将响应体解析为 JSON 对象,response返回的数据是Buffer类型的,正常使用需要转换
const jsonResponse = pm.response.json();
// 获取响应中的 Cookie
const responseCookies = pm.response.cookies;
可使用的外部库
postman可用的外部库官网有13个:ajv、atob、btoa、chai、cheerio、crypto-js、csv-parse/lib/sync、lodash、moment、postman-collection、tv4、uuid、xml2js
部分NodeJS模块也是可以使用的,具体有哪些可以看一下文档
参数传递事例
事例为角色列表接口获取数据,随机从取到的数据中取一个对象,将其中两个字段放到集合变量中,供角色详情接口查询使用
js
// Tests 脚本
const response = pm.response.json()
var roleList = [];
// console.log(response);
if(response.success && response.data.data.length>0){
roleList = response.data.data
let max = response.data.data.length
let randomNum = Math.floor(Math.random() * max)
let role = roleList[randomNum];
// console.log('role',role)
pm.collectionVariables.set('applicationCode',role.applicationCode)
pm.collectionVariables.set('roleCode',role.roleCode)
}