乐趣区

Postman 快速入门之脚本语法

Postman 是访问各种 API 的客户端。它的强大之处在于其允许在对某一个 request 访问的之前和之后分别运行自定义的一段 Javascript 脚本,这样直接就完成了一个 chain request 的效果,可以将数条 request 连结成一个流程完成一体化测试。这在很多的 API 操作中都是极其有用的,所以这里有必要总结一些常用语句。
脚本执行流程

pre-request 脚本,是在对 API 进行请求之前的脚本,一般用于动态生成参数、JSON 数据包、链接地址等。

test 脚本,其实更应该叫 post-request,实在完成 API 访问并得到其 response 回应之后运行的脚本,一般用于获取 response 的内容,用于之后对于别的资源的请求,如获取页面标题和内容等。

运行脚本要求
需要注意,pre-request 脚本,在里面直接写代码就可以了,但是 test 脚本需要在某个指定的函数 pm.test(…) 中执行才会被识别,且作为 test 脚本运行。如下图:pm.test() 中第一个参数是测试描述 ( 会在测试结果栏显示,应和其它测试描述做以区分),第二个参数是一个函数,具体执行代码都在这个函数中运行。另外,pm 对象是 Postman 的主要对象,所有的内置函数,数据调用等,都需要通过它来实现。
脚本调试
如果要看已经设置的 Enviroment 变量的话,可以点开右上方小眼睛看到,如下图,我设置了 3 个环境变量:
调试时要打印的话,一般都是用 console.log(…),这样就能在 console 中看到。如果你的 Postman 是 Chrome app 的话,直接在 chrome 浏览器的开发者工具里调试就行。如果是 Mac 等桌面软件,则需要打开内置的 console 才能看到调试信息。位置在左下角,如下图:
常用语句 Code Snippets
一般会在脚本编写栏的右边都会有常用语句片段,点击以下就会出来代码,但是一开始不太了解的话点出来其实也看不懂。如下图:
官方文档解释的各种函数调用链接在这里:Postman Sandbox
以下是我自己总结的常用代码片段:
// 获取 response 返回内容
var rsb = responseBody; // 是字符串格式

// 获取环境变量
var v = pm.environment.get(“ 变量名称 ”);

// 设置环境变量 只能存储字符串,如果是对象的话则无法在下次运行时获取到内容
// 如需要存储 JSON 数据,可以用 JSON.stringify(..) 存储,再用 JSON.parse(..) 转化为对象使用
pm.environment.set(“ 变量名称 ”, 变量内容);

// 清除某个环境变量
pm.environment.unset(“ 环境变量名 ”);

// 获取全局变量和普通变量
var gb = pm.globals.get(“ 全局变量名 ”);
var nm = pm.variables.get(“ 普通变量名 ”);

// Javascript 获取变量类型
console.log(typeof pm.enviroment);
测试结果
除了上面的具体功能代码外,经常还需要返回一个结果,告诉 Postman 这个测试结果是 Pass 还是 Fail,默认是 pass。
这里返回值就不是简单的 return 语句可以,必须要通过 Postman 自带的对象或方法才可以,一般是通过 pm.expect() 或 tests[] 这两个地方返回测试结果。
这些方法名看起来都很容易理解,一般都会叫 pm.expect() 或.to.be() 或.to.have() 这样的,字面意思就是期待什么或要求它必须是什么或必须有什么,才能通过测试。另外,同样的测试结果,实际上还有更简单的写法,即不通过 pm 对象,而是内置 tests 对象,常用操作如下:

# 反应时间必须少于 200 毫秒
tests[“Response time is less than 200ms”] = responseTime < 200;

# 判断反应代号是否等于某一个指定的代号
tests[“Status code name has string”] = responseCode.name.has(“Created”);

看这个用法,猜测 tests 是一个 JSON 格式的对象,tests[…] 括号内的字符串是测试的描述,= 后面是判断语句,然后将 True 或 False 赋予为 tests[..] 的值,然后 postman 轮训所有 tests 对象里的参数,并返回 pass 与否的结果。
这里是官方总结的常用测试脚本方法:Test examples
以下是我总结的常用的返回测试结果的内置函数:
#“期待”返回结果必须包含某一段内容
pm.expect(从 response 里获取的字符串).to.include(“ 必须包含的内容 ”);

# 返回 body 值必须完全等于某一段内容
pm.response.to.have.body(“ 必须等于的内容 ”);

# 反应时间必须少于 200 毫秒
pm.expect(pm.response.responseTime).to.be.below(200);

# 必须返回某一个状态 如 ”Created”
pm.response.to.have.status(“ 状态名 ”);

退出移动版