Postman的使用

发表于 2019-05-22 分类于工具

常见接口测试工具

Postman: 简单方便的接口调试工具，便于分享和协作。具有接口调试，接口集管理，环境配置，参数化，断言，批量执行，录制接口，Mock Server, 接口文档，接口监控等功能
JMeter: 开源接口测试及压测工具，支持Linux及无界面运行
LR: 商业版接口性能测试工具，简单易用，功能强大
SoupUI: 开源，WebService接口常用测试工具，也可以测试Rest接口及接口安全

新版Postman使用简介

Postman 官网地址：https://www.getpostman.com/pricing
Postman主界面
Postman用法介绍

工具栏

New: 新建，可以新建Request请求，Collection请求集，环境等等
Import: 导入，可以导入别人导出的请求集
Runner: 运行一个请求集（批量执行）
Invite: 邀请（需要注册，邀请进行协作）
同步图标：（需要注册，同步你的项目到云端）
抓包图标：抓包/捕获请求，用于开启Postman代理，手动设置代理（或手机代理）后可抓包/录制请求
设置图标： Postman设置
消息图标：官方及协助消息
收藏图标：我的收藏（需要注册）
云端图标：用户云端数据（需要注册）

接口管理区

History: 请求历史记录，可以查询到之前的请求记录
Collections: 接口集，相当于一个接口项目或测试计划，接口集中可以建立无限极子文件夹，用于对接口进行分组管理

环境管理区

环境切换：用于切换环境
环境预览：用于快速预览环境中的所有变量
环境管理：用于添加修改环境及环境变量，以及全局变量

什么是环境

接口完整地址 = 服务地址 + 接口地址，如
https://app.jike.ruguoapp.com + /1.0/users/login
环境是一套配置，包含许多环境变量。在接口测试中，根据部署在不同的服务器上，服务器地址有可能不同，而同一个接口，接口地址是不变的。为了测试部署在不同服务器上的同一套接口，我们可以建立不同的环境，不同环境中host变量使用不同的地址

接口设计区

可以通过上方tab边上的+号，新建多个请求。接口设计区从上到下分为请求区和响应区

请求区
- 请求地址行：可以选择请求方法（GET/POST/…），填写请求地址，发送请求和保存请求到测试集
- 请求数据区：分为授权，请求头，请求数据，请求发送前执行的脚本（用于准备数据），请求结束后执行的脚本（用于断言）
响应区：
- 响应内容：可以查看Pretty（美化格式），Raw（原始格式），Preview（HTML预览格式）
- 响应Cookie
- 响应头
- 测试结果，对应请求中Tests中设置的断言
  Collection请求集
  测试集是Postman中接口管理的一个“整体”单位，运行、导出、分享等都是基于测试集的。
新建测试集： New按钮->Collection 或直接点击测试集列表上方的新建测试集按钮
- 授权：测试集及其子文件夹下的接口统一使用该授权，不用每个接口再都单独设置一遍
- 请求前脚本：测试集的每个接口公用的请求前脚本
- 请求后断言：测试集每个接口公用的请求后脚本
- 请求集变量：请求集中公用的一些变量
子文件夹：子文件夹的属性中同样拥有描述，授权，请求前脚本，和请求后断言（没有变量，一个请求集的变量统一管理），实现了不同范围（Scope）的Fixture功能。
请求集导出：请求集可以导出并发送给别人（不携带环境信息），别人通过导入来使用你的接口
请求集分享：请求集直接分享给别人（双方都需要注册）
环境管理
- 我们可以环境中设置多个变量，以供在请求中使用
- 环境变量使用方法：
  - 选择环境，在请求URL或者请求Body里使用来使用环境变量
  - 变量可以在请求Body的各种格式中使用
  - 不能直接在请求前脚本（Pre-request Script）和请求后脚本（Tests）中使用
- 环境管理中还可以点击“Global”添加全局变量，环境变量只有当选择了该环境时生效，全局变量在任何环境中生效，测试集中的变量只在当前测试集生效，当测试集变量，环境变量，全局变量有重复的变量名时，优先级为：环境变量>全局变量>测试集变量

Params使用

当请求URL中参数很多时，不方便进行添加和查看，可以点击Params按钮，以表格的方式添加变量及值，从表格添加后，变量和值会自动添加到URL中

请求设计

授权：如果接口需要授权，可以在该页面设置授权方式（type）和授权信息
Header: 请求头，可以设置请求类型（Content-Type）和Cookie
Body: 请求数据
- form-data：混合表单，支持上传文件
- x-www-form-urlencoded：文本表单
- raw：原始格式，支持JSON/XML格式（后面可选择）
- binary: 二进制格式，用于发送二进制数据流
Pre-request Script: 请求前脚本，Javascript语法，用于在发送请求前生成一些动态数据或做一些处理
Tests：请求后脚本，Javascript语法，用于请求返回后做一些处理或断言结果

Postman发送各种格式请求的方法：

注意：选择不同的请求，会自动在Header中添加Content-Type信息

Tests断言

一个Postman的test本质上是JavaScript的代码可以用来为一些特殊的test设置值。你可以在对象中设置一个描述性的键作为一个元素，然后声明他如果是true或false。
tests[“Body contains user_id”] = responseBody.has(“user_id”)
这回核对body中是否包含了user_id这个字符串。如果你需要，你可以增加更多的键，这取决于你要用test做多少的事情。

HTTP状态码断言:

1	tests["HTTP状态码200"]=responseCode.code == 200;

响应包含内容断言：

1	tests["状态码200"] = responseBody.has("登录成功"\|"你已经登录，无需重复登录");

接口样例
POST https://demo.fastadmin.net/admin/index/login.html 用户名/密码： username:admin password:123456

JSON响应断言

1 2	var jsonData = JSON.parse(responseBody); //获取body中返回的所有参数 tests["code为100000表示成功"] = jsonData.code == "100000"

接口样例 GET http://www.tuling123.com/openapi/api?key=ec961279f453459b9248f0aeb6600bbe&info=你好

tests

Postman尝试通过列出编辑器旁边常用的片段来简化过程。您可以选择要添加的代码段，并将相应的代码添加到测试编辑器中。

Runner: 测试集批量执行

支持设置迭代次数
支持加载csv或json类测试数据
操作方法：https://demo.fastadmin.net/admin/index/login.html接口
新建一个Collection，比如名称Demo2
填入URL：https://demo.fastadmin.net/admin/index/login.html，选择POST方法
请求数据（Body）格式选x-www-form-urlecoded，请求数据填写username password ，这里使用了两个变量来做参数化
保存请求到Demo2中
在电脑上新建一个data.csv文件，第一行为变量名
点击Postman工具栏的Runner按钮，Collection选择Demo2， Data选择数据文件data.csv，点击运行Demo2

环境变量的用法详解

在postman中，可以利用tests将接口返回的response设置为环境变量，供后续接口使用（类似参数化的概念）

var jsonData =JSON.parse(responseBody); //获取body中返回的所有参数
postman.setEnvironmentVariable("appKey",jsonData.data.appKey);//把返回参数中的keys设置为环境变量

var data = postman.getResponseHeader("Access-Token"); //获取响应头所有参数
postman.setEnvironmentVariable("Access-Token",data); //把返回参数中的Access-Token设置为环境变量

postman常用方法集合

https://learning.getpostman.com/docs/postman/scripts/test_examples/

环境变量

//设置环境变量
pm.environment.set("variable_key", "variable_value");

//将一个嵌套的对象设置为一个环境变量
var array = [1, 2, 3, 4];
pm.environment.set("array", JSON.stringify(array, null, 2)); 

var obj = { a: [1, 2, 3, 4], b: { c: 'val' } };
pm.environment.set("obj", JSON.stringify(obj)) 

//获取环境变量
pm.environment.get("variable_key"); 

//获取环境变量（其值是字符串化对象)
// 如果数据来自未知源，则应该将这些语句包装在try-catch块中
var array = JSON.parse(pm.environment.get("array"));
var obj = JSON.parse(pm.environment.get("obj"));

//清除环境变量
pm.environment.unset("variable_key"); //清除一个环境变量

全局变量

1
2
3

pm.globals.set("variable_key", "variable_value"); //设置一个全局变量
pm.globals.get("variable_key"); //获取一个全局变量
pm.globals.unset("variable_key"); //清除一个全局变量

获取一个变量

该函数在全局变量和活动环境中搜索变量

1	pm.variables.get("variable_key");

检查response body中是否包含某个string

tests["Body matches string"] = responseBody.has("string_you_want_to_search");

pm.test("Body matches string", function () {
    pm.expect(pm.response.text()).to.include("string_you_want_to_search");
});

检查response body是否与某个string相等

tests["Body is correct"] = responseBody === "哈哈哈"; //必须完全匹配

pm.test("Body is correct", function () {
    pm.response.to.have.body("response_body_string");
});

检测JSON中的某个值是否等于预期的值

var data = JSON.parse(responseBody);
tests["Your test name"] = data.value === 100;
tests["状态码为301"] = data["status"] == "301";
tests["message"] = data["message"] == "购买商品库存不足";
tests["list"] = data["lists"][0] == "11";

pm.test("Your test name", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.value).to.eql(100);
});

JSON.parse()方法，把json字符串转化为对象。parse()会进行json格式的检查是一个安全的函数。
如：检查json中某个数组元素的个数(这里检测programs的长度)

1 2	var data = JSON.parse(responseBody); tests["program's lenght"] = data.programs.length === 5;

测试response Headers中的某个元素是否存在(如:Content-Type)

//getResponseHeader()方法会返回header的值，如果该值存在的话
tests["Content-Type is present"] = postman.getResponseHeader("Content-Type");  //不区分大小写
tests["Content-Type is present"] = responseHeaders.hasOwnProperty("Content-Type"); //要区分大小写 

pm.test("Content-Type is present", function () {
    pm.response.to.have.header("Content-Type");
});

验证响应时间小于xxx毫秒

tests["Response time is less than 200ms"] = responseTime < 200;

pm.test("Response time is less than 200ms", function () {
    pm.expect(pm.response.responseTime).to.be.below(200);
});

响应时间在特定范围内（包含下限，上限不包括）

1	tests["Response time is acceptable"] = _.inRange(responseTime, 100, 1001);

验证状态码的值为200

tests["Status code is 200"] = responseCode.code === 200;

pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
});

代码名包含一个字符串

tests["Status code name has string"] = responseCode.name.has("Created");

pm.test("Status code name has string", function () {
    pm.response.to.have.status("Created");
});

成功的POST请求状态代码

tests["Successful POST request"] = responseCode.code === 201 || responseCode.code === 202;

pm.test("Successful POST request", function () {
    pm.expect(pm.response.code).to.be.oneOf([201,202]);
});

使用TinyValidator获取JSON数据

var schema = { "items": { "type": "boolean" }};
var data1 = [true, false];
var data2 = [true, 123];
pm.test('Schema is valid', function() {
  pm.expect(tv4.validate(data1, schema)).to.be.true;
  pm.expect(tv4.validate(data2, schema)).to.be.true;
});
//data1和data2是测试数据，schema相当于验证json的规范 
//示例中验证data1和data2中的value是否都是boolean类型

获取request值：

data {object}:
这是一个用于请求的表单数据字典 (request.data[“key”]==”value”)
headers {object}:
这是请求头的字典 (request.headers[“key”]==”value”)
method {string}:
GET/POST/PUT 等.
url {string}:
请求的url

1	var Json = JSON.parse(request.data);

假设requestBody中有”version”:”1.0”；这个值,如果想获取到version的value值，代码如下

1 2	var Json = JSON.parse(request.data); var version = Json["version"];

JSON.parse()和JSON.stringify()

JSON.parse() //【从一个字符串中解析出json对象】--把string转对象
JSON.stringify() //【从一个对象中解析出字符串，主要针对[object object]类型数据的转换】--把对象转String

var data={name:'goatling'}

JSON.parse(data)
//结果是： '{"name":"goatling"}'

JSON.stringify(data)
//结果是：name:"goatling"

发送异步请求。此功能既可用作预请求脚本，也可用作测试脚本。

1
2
3

pm.sendRequest("https://postman-echo.com/get", function (err, response) {
    console.log(response.json());
});

转换XML body为JSON对象

1	var jsonObject = xml2Json(responseBody);

判断字段值是否为空typeof()

1 2	var Jsondata = JSON.parse(responseBody); if( typeof(Jsondata.data) != "undefined" )

分支和循环

//设置下一个要执行的请求
postman.setNextRequest("request_name");
//停止工作流程执行
postman.setNextRequest(null);

postman.setNextRequest()一些重点：
* 指定后续请求的名称或ID，集合运行器将负责其余的请求。
* 它可以用在预请求或测试脚本中。如果有多个赋值，则考虑最后一个赋值。
* 如果postman.setNextRequest()请求中不存在，则集合运行器默认为线性执行并移至下一个请求

服务端返回异常 Status Code：

HTTP状态码

1** 信息，服务器收到请求，需要请求者继续执行操作
2** 成功，操作被成功接收并处理
3** 重定向，需要进一步的操作以完成请求
4** 客户端错误，请求包含语法错误或无法完成请求
5** 服务器错误，服务器在处理请求的过程中发生了错误

常见HTTP响应码

200：成功
301、302：请求重定向到另外一个接口
400：请求格式不对／服务端故意失败
403：禁止访问(被封禁／没有权限)
404：资源不存在（有可能是请求url错误或参数不正确）
405：请求方法不被允许（比如接口只允许Post,使用Get请求接口）
429：请求频率过高
500：服务器内部错误（通常是服务器挂了或接口Bug)
502、503：服务发布间隙没衔接好／挂了
504：网关请求超时（Bug，挂了）
409、406：正常返回，不应该被记录