Postman Pre-request Script (postman脚本) 编写

2020-09-22 / Postman js

Postman Pre-request Script (postman脚本) 编写

Psotman 版本

v7.29.1

Pre-request Script 编写

环境变量

//设置当前环境变量
pm.environment.set("key", "value");
//获取当前环境变量
pm.environment.get("key");
//清除当前环境变量
pm.environment.unset("key");
//设置全局环境变量
pm.globals.set("key", "value");
//获取全局环境变量
pm.globals.get("key");
//清除全局环境变量
pm.globals.unset("key");
//在全局和当前环境变量中获取
pm.variables.get("key");
//设置集合
pm.collectionVariables.set("key",["value1","value2","value3"])
//获取集合
pm.collectionVariables.get("key");
//清除集合
pm.collectionVariables.unset("key");
//遍历集集合，遍历function(遍历当前值,索引,集合,)
pm.collectionVariables.get("key").forEach(function(a,b,c){
console.log(a);
console.log(b);
console.log(c);
});

GET请求

//获取当前请求方式,返回:string
var method = pm.request.method;
//输出当前请求信息,返回:json
var request = pm.request.toJSON();
//输出当前请求url,返回:string
var url = pm.request.url.toString();
//输出当前请求参数,参数(是否编码):true  false ,返回:string
var querypararm =  pm.request.url.getQueryString(false);
//获取请求参数,参数(请求的键值)(string 类型),返回:string
var value = pm.request.url.query.get("key_name");
//删除请求参数,参数(请求的键值)
pm.request.url.query.remove("key_name");
//添加请求参数,参数(添加请求参数),数组类型
pm.request.url.query.add("key1=value1","key2=value2");
//判断某个键值是否存在,返回:boolean
var has = pm.request.url.query.has("key");

内置请求

//定义请求信息
var requests = {
     url:url,//请求url
     method: 'POST',//请求方式
     header: {'Content-Type':'application/json'},//请求header
     body: {
     mode: 'raw',//数据模型
     raw: JSON.stringify({mobile:raw.mobile,useScene:"login"})//数据
  }
 };

//发送请求,参数:请求信息,响应函数(异常,响应数据)
 pm.sendRequest(requests,function (err, response) {
      var result = response.json();
      console.log(result);
   
 });

POST请求

//获取所有headers
var header = pm.request.getHeaders();
//移除header
pm.request.removeHeader("key");
//添加header
pm.request.addHeader("key:value");
//获得body中的内容,返回:string
 var body = pm.request.body.raw;
//重新设置body内容,参数:string
 pm.request.body.update("");
//添加param参数,参数:string或者QueryParam对象
pm.request.addQueryParams("key=value");
//移除para参数,参数:数组字符串
pm.request.removeQueryParams("1","2");

Cookies

//创建一个cookie容器
const cookieJar = pm.cookies.jar();

//设置cookie,参数: url,cookieName,cookieValue,回调函数function(异常,设置成功的cookie)
/**
 * 如果设置失败,提示如下:Unable to access "xxxx.com" cookie store. Try    whitelisting the domain in "Manage Cookies 
 * 点击界面的 Cookies > Whitelist Domains(左下角) > 在输入框中加入xxxx.com 点击
 * add
 */
cookieJar.set("xxxx.com","name","value",function(error,cookie){
console.log(error);
console.log(cookie);
})

//获取cookie,参数: url,cookieName,回调函数function(异常,cookie)
cookieJar.get("xxxx.com","name",function(error,cookie){
console.log(error);
console.log(cookie);
})

//获取所有cookie,参数: url,回调函数function(异常,cookie)
cookieJar.getAll("xxxx.com", function(error, cookies){
console.log(error);
console.log(cookie);
});

//删除cookie,参数: url,cookieName,回调函数function(异常)
cookieJar.unset("xxxx.com", "name", function(error){
console.log(error);
});

//删除所有cookie,参数: url,回调函数function(异常)
cookieJar.clear("xxxx.com", "name", function(error){
console.log(error);
});

工具

//字符串转json对象
var json =JSON.parse("");

//json对象转字符串
var string = JSON.stringify(obj);

//获取当前时间的时间格式
var time = require('moment')().format("YYYY-MM-DD HH:mm:ss");

//参数编码参数
var encodeURI = encodeURIComponent("");

//编码整个url
var encodeURI = encodeURI("");

//base64编码
var content = CryptoJS.enc.Utf8.parse("1");
var base64Content = CryptoJS.enc.Base64.stringify(content);

//base64解码
var parsedWordArray = CryptoJS.enc.Base64.parse(base64Content);
var wordString = parsedWordArray.toString(CryptoJS.enc.Utf8);

//xml转换json对象,参数：请求响应的xml
var jsonObject = xml2Json(responseBody);

//解析响应的csv
const parse = require('csv-parse/lib/sync');
const responseJson = parse(pm.response.text());

//解析html
const $ = cheerio.load(pm.response.text());
console.log($.html());

//MD5加密
var md5 = CryptoJS.MD5("").toString();

//SHA1加密
var sha1 = CryptoJS.SHA1("").toString();

//AES加密
const keys = CryptoJS.enc.Utf8.parse("123456789");//秘钥
const ivs = CryptoJS.enc.Utf8.parse('tltlaycvtweasa');//偏移量
let encryptedWord = CryptoJS.enc.Utf8.parse("1");//加密内容
var encrypted = CryptoJS.AES.encrypt(encryptedWord, keys, { iv: ivs,mode:CryptoJS.mode.CBC, padding: CryptoJS.pad.Pkcs7}); //加密结果
var ciphertext = encrypted.toString(); //密文

Tests编写

值获取

//请求耗时
var time = pm.response.responseTime;
//获取响应code
var code = pm.response.code;
//获取错误描述:例如返回200,下面返回的是OK
var status = pm.response.status;
//获取响应数据
var data = pm.response.json();
//获取响应header
var header = pm.response.headers.get("key");

模板判断

//断言响应中是否包含指定字符串
pm.test("断言响应体包含指定字符串", function () {
    pm.expect(pm.response.text()).to.include("指定字符串");
});


//断言响应是否等于指定字符串
pm.test("断言响应是否等于指定字符串", function () {
    pm.response.to.have.body("指定字符串");
});
 

//断言json值是否等于指定值
pm.test("断言json值是否等于指定值", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.value).to.eql(100);
});

//断言是否存在Content-Type标头
pm.test("断言是否存在Content-Type标头", function () {
    pm.response.to.have.header("Content-Type");
});

//断言cookie是否存在
pm.test("断言cookie是否存在", () => {
  pm.expect(pm.cookies.has('JSESSIONID')).to.be.true;
});

//断言cookie是否等于特定值
pm.test("断言cookie是否等于特定值", () => {
  pm.expect(pm.cookies.get('JSESSIONID')).to.eql('1');
});

//断言响应时间小于200ms
pm.test("断言响应时间小于200ms", function () {
    pm.expect(pm.response.responseTime).to.be.below(200);
});

//断言状态码为200
pm.test("断言状态码为200", function () {
    pm.response.to.have.status(200);
});


//断言状态响应说明是否包指定值
pm.test("断言状态响应说明是否包指定值", function () {
    pm.response.to.have.status("Created");
});

//断言成功响应状态码,oneOf表示在一组值中
pm.test("断言成功响应状态码", function () {
    pm.expect(pm.response.code).to.be.oneOf([201,202]);
});

//断言环境值和响应回来的值
pm.test("断言环境值和响应回来的值", function () {
  pm.expect(pm.response.json().name).to.eql(pm.environment.get("name"));
});

//断言响应数据类型
/* 响应数据结构如下
{
  "name": "Jane",
  "age": 29,
  "hobbies": [
    "skating",
    "painting"
  ],
  "email": null
}
*/
const jsonData = pm.response.json();
pm.test("Test data type of the response", () => {
  pm.expect(jsonData).to.be.an("object");//是否为对象类型
  pm.expect(jsonData.name).to.be.a("string");//是否为字符串类型
  pm.expect(jsonData.age).to.be.a("number");//是否为数字类型
  pm.expect(jsonData.hobbies).to.be.an("array");//是否为数组
  pm.expect(jsonData.website).to.be.undefined;//是否未定义
  pm.expect(jsonData.email).to.be.null;//是否为null
});

//断言数组
/* 响应数据结构如下
{
  "errors": [],
  "areas": [ "goods", "services" ],
  "settings": [
    {
      "type": "notification",
      "detail": [ "email", "sms" ]
    },
    {
      "type": "visual",
      "detail": [ "light", "large" ]
    }
  ]
}
*/
const jsonData = pm.response.json();
pm.test("Test array properties", () => {
    //判断是否为空
  pm.expect(jsonData.errors).to.be.empty;
    //判断是否包含 "goods"
  pm.expect(jsonData.areas).to.include("goods");
    //判断 settings 中的object是否有type='notification'
  const notificationSettings = jsonData.settings.find
      (m => m.type === "notification");
  pm.expect(notificationSettings)
    .to.be.an("object", "Could not find the setting");
    //判断是否notificationSettings.detail中是否包含"sms"
  pm.expect(notificationSettings.detail).to.include("sms");
    //判断是否notificationSettings.detail中是否包含如下所有成员
  pm.expect(notificationSettings.detail)
    .to.have.members(["email", "sms"]);
});

//断言一个对象包含键或属性
//断言包含所有的key
pm.expect({a: 1, b: 2}).to.have.all.keys('a', 'b');
//断言包含任何一个成员
pm.expect({a: 1, b: 2}).to.have.any.keys('a', 'b');
//断言不包含任何一个成员
pm.expect({a: 1, b: 2}).to.not.have.any.keys('c', 'd');
//断言是否包含a属性
pm.expect({a: 1}).to.have.property('a');
//断言值是否为object对象,并且包含所有的key
pm.expect({a: 1, b: 2}).to.be.an('object')
  .that.has.all.keys('a', 'b');

//TV4校验

//定义校验模型,要求值为boolean类型
var schema = {
 "items": {
 "type": "boolean"
 }
};
//定义测试数据
//满足要求
var data1 = [true, false];
//不满足要求
var data2 = [true, 123];
//校验TV4模型
pm.test('校验TV4模型', function() {
  pm.expect(tv4.validate(data1, schema)).to.be.true;
  pm.expect(tv4.validate(data2, schema)).to.be.true;
});


//JSON模型校验

//构建Ajv
var Ajv = require('ajv');
//初始化
var ajv = new Ajv({logger: console})
//定义规则
var schema = {
        "properties": {
            "alpha": {
                "type": "boolean"
            }
        }
    };
//定义测试数据
//符合规则
var test1 = {alpha: true};
//不符合规则
var test2 = {alpha: 123};
//校验
pm.test('JSON模型校验', function() {
    pm.expect(ajv.validate(schema, test1)).to.be.true;
    pm.expect(ajv.validate(schema, test2)).to.be.false;
});



//将请求结果可视化
//数据样例
/**
 [
    {
        "name": "Alice",
        "email": "alice@example.com"
    },
    {
        "name": "Jack",
        "email": "jack@example.com"
    },
    // ... and so on
]
*/
//数据模板
var template = `
    <table bgcolor="#FFFFFF">
        <tr>
            <th>Name</th>
            <th>Email</th>
        </tr>

        {{#each response}}
            <tr>
                <td>{{name}}</td>
                <td>{{email}}</td>
            </tr>
        {{/each}}
    </table>
`;
//填充数据模板
pm.visualizer.set(template, {
    response: pm.response.json()
});

动态变量

获取方式

//动态变量获取
pm.variables.replaceIn('{{$randomFirstName}}');

值列表

标题：Postman Pre-request Script (postman脚本) 编写
作者：adongs
地址：https://adongs.com/articles/2020/08/10/1597044862445.html

我的日记

记录精彩的程序人生

Postman Pre-request Script (postman脚本) 编写

Psotman 版本

Pre-request Script 编写

环境变量

GET请求

内置请求

POST请求

Cookies

工具

Tests编写

值获取

模板判断

动态变量

获取方式

值列表