postman变量和脚本功能介绍

1、基本概念——global、collection、environment

在postman中,为了更好的管理各类变量、测试环境以及脚本等,创建了一些概念,包括:globals、collection、environment。其实在postman中,最上层还有一个Workspaces的概念,不过大多数情况我们都使用一个workspace,这里就不多介绍了。

1.1)请求组(collection):

可以将多个请求保存到一个请求组(Collections)中, 好处是: 增加额外Collection变量作用域, 增加公共的PreRequest和Test脚本, 批量执行Collection下的请求, 定义Collection内请求的顺序。

上图中可以看到,左上角“+”可以创建新的collection;点击collection的右侧“。。。”可以Edit现有collection,以及Run、Add folder等功能。

说明Collection下还可以建文件夹,对请求进一步划分,比如:用户模块、订单模块。

1.2)环境(environment):

通常一个系统具备多个环境,比如:测试、线上。

如上图,点击左上角“+”可以新建一个environment;鼠标指向现有environment,点击右侧“。。。”可以进行编辑。值得提醒的是,当运行时,需要在右上角选中我们想要的环境。

变量有两个value(不光是环境变量,其他变量也是一样的),二者的区别:

  • INITAL_VALUE:初始值是在定义变量的元素(集合、环境或全局变量)中设置的值。此值将同步到 Postman 的服务器,并在您共享该元素时与您的团队共享
  • CURRENT_VALUE:这些是本地值,不会同步到 Postman 的服务器。如果您更改当前值,它将不会保留在原始共享集合、环境或全局变量中。

1.3)golbal:

细心的朋友已经发现,在environment中,左上角出现了Golbals:

2、变量

变量,在postman中最常见的一个功能,包括设置、读取、作用域等。

2.1)变量作用域:

postman中变量有多个作用域, 越往内的作用域优先级越高(global < collection < environment < …), 举例来说, 如果global作用域和Environment作用域里都有一个变量叫username, 那么最终使用的是Environment作用域里的变量值。

 

 不同作用域变量设置方法:

2.2)定义、使用变量

从上面图可以看到,在UI界面上可以管理globals变量,后面也会降到使用API方式设置、读取globes变量(会同步出现在UI界面上);同样的,对于environment变量也是一样的。(如上面1.2和1.3)

1)通过界面定义变量:

选中某个值,然后点击弹出的菜单点击"Set as new variable":

 

然后这只变量名、和作用域:

 

2)管理Collections变量:

选择某个Collection后,点击右侧的“。。。”,然后选择Edit,在右侧界面上会显示Variables。

3)使用变量:

在不同作用域定义好变量后, 然后在某个请求中引用该变量, 从而做到变量复用和统一管理。

 使用"{{变量名}}"来引用变量。

2.3)在脚本中操作变量

// 不同作用域设置变量
pm.globals.set("username", "golbals_name");
pm.globals.set("username1", "golbals_name1");
pm.collectionVariables.set("username", "collection_name");
pm.environment.set("username", "environment_name");
pm.variables.set("username", "variable_username"); //临时覆盖, 优先级最高, 请求结束后失效

// 获取变量值
console.log(pm.globals.get("username")); //从globals作用域中查询变量
console.log(pm.collectionVariables.get("username"));
console.log(pm.environment.get("username"));
var k = pm.variables.get("username1"); //依次从各个作用域查找
console.log("username:" + k);


// 判断
pm.variables.has("username");
pm.environment.has("username");
pm.globals.has("username");

// 清理
pm.environment.unset("username");

2.4)data作用域的变量

在UI界面上,选择Collection的Run,在界面中可以选择一个文件

 

然后准备一个文件,内容如下:(必须是json或者csv格式)

[{
  "path": "post",
  "value": "1"
}, {
  "path": "post",
  "value": "2"
}, {
  "path": "post",
  "value": "3"
}, {
  "path": "post",
  "value": "4"
}]

另外,在脚本里访问data文件可以使用如下AIP:

pm.iterationData.get("value");

3、脚本

postman API文档:Home - Postman Documentation

3.1)脚本相关概念:

1)脚本执行顺序:

执行每个请求时会依次执行如下脚本:

  1. Collection级别的pre-request脚本
  2. Folder级别的pre-request脚本
  3. Request级别的pre-prequest脚本
  4. Request级别的test脚本
  5. Folder级别的test脚本
  6. Collection级别的test脚本

 

2)在界面上输入脚本信息: 

最常见的就是request级别的脚本,可以在Scripts页签下输入,如下:

可以看到,脚本分两个:pre-request和post-reponse,分别对应请求前处理和请求后处理。

在Collection级别上也可以创建脚本,如下:

同样,如果在Collection下有folder,那么folder上也可以创建scripts。 

3.2)常用脚本代码

1)操作变量:

// 设置全局变量
pm.globals.set('variable_key', 'variable_value');
var variable_key = pm.globals.get('variable_key');// 获取全局变量
pm.globals.unset('variable_key');// unset 全局变量

// 设置环境变量
pm.environment.set('variable_key', 'variable_value');
var variable_key = pm.environment.get('variable_key');// 获取环境变量
pm.environment.unset('variable_key');// unset 环境变量

// 设置临时变量
pm.variables.set('variable_key', 'variable_value');
var variable_key = pm.variables.get('variable_key');// 获取临时变量
pm.variables.unset('variable_key');// unset 临时变量

// 将对象或数组(非字符串)写入环境变量
var array = [1, 2, 3, 4];
pm.environment.set('array', JSON.stringify(array));
var obj = { a: [1, 2, 3, 4], b: { c: 'val' } };
pm.environment.set('obj', JSON.stringify(obj));
// 转换回来
try {
  var array = JSON.parse(pm.environment.get('array'));
  var obj = JSON.parse(pm.environment.get('obj'));
} catch (e) {
  // 处理异常
}

2)前置读取/修改接口信息:

// ================= URL ===================
// 获取 url 对象
var urlObject = pm.request.url;

// 获取完整接口请求 URL,包含 query 参数
var url = urlObj.toString();

// 获取协议(http 或 https)
var protocol = urlObj.protocol;

// 获取 端口
var port = urlObj.port;

// ================= Header ===================
// 获取 Header 参数对象
var headers = pm.request.headers;

// 获取 key 为 field1 的 header 参数的值
var field1 = headers.get('field1');

// 已键值对象方式获取所有 query 参数
var headersObject = headers.toObject();

// 遍历整个 query
headers.each(item => {
    console.log(item.key); // 输出参数名
    console.log(item.value); // 输出参数值
});

// 增加 header 参数
headers.add({
    key: 'field1',
    value: 'value1',
});

// 修改 query 参数(如不存在则新增)
headers.upsert({
    key: 'field2',
    value: 'value2',
});

// ================= Query ===================
// 获取 Query 参数对象
var queryParams = pm.request.url.query;

// 获取 key 为 field1 的 query 参数的值
var field1 = queryParams.get('field1');

// 已键值对象方式获取所有 query 参数
var quertParamsObject = queryParams.toObject();

// 遍历整个 query
queryParams.each(item => {
    console.log(item.key); // 输出参数名
    console.log(item.value); // 输出参数值
});

// 增加 query 参数
queryParams.add({
    key: 'field1',
    value: 'value1',
});

// 修改 query 参数(如不存在则新增)
queryParams.upsert({
    key: 'field2',
    value: 'value2',
});

// ================= Body ===================
// Body 参数来自pm.request.body,pm.request.body 是一个RequestBody 实例。
// Body 参数在只能读取,不能直接修改。如需修改 Body 里的数据,请在 Body 里引用变量,然后在脚本里设置变量的值,以达到修改的目的。

// --------------------- body 类型为 form-data ------------------
// 当 body 类型为 form-data 时,从 pm.request.body.formdata 获取请求参数
var formData = pm.request.body.formdata;

// 获取 key 为 field1 的 form-data 参数的值
var field1 = formData.get('field1');
console.log(field1); // 控制台打印 field1

// 已键值对象方式获取所有 formdata 参数
var formdataObject = formData.toObject();
console.log(formdataObject); // 控制台打印 formdataObject

// 遍历整个 form-data 数据
formData.each(item => {
    console.log(item.key); // 控制台打印参数名
    console.log(item.value); // 控制台打印参数值
});

// --------------------- body 类型为 x-www-form-urlencode ------------------
// 当 body 类型为 x-www-form-urlencode** 时,从 pm.request.body.urlencoded 获取请求参数
var formData = pm.request.body.urlencoded;

// 获取 key 为 field1 的 form-data 参数的值
var field1 = formData.get('field1');

// 已键值对象方式获取所有 formdata 参数
var formdataObject = formData.toObject();

// 遍历整个 form 数据
formData.each(item => {
    console.log(item.key); // 控制台打印参数名
    console.log(item.value); // 控制台打印参数值
});

// --------------------- body 类型为 JSON ------------------
try {
    var jsonData = JSON.parse(pm.request.body.raw);
    console.log(jsonData); // 控制台打印参整个 json 数据
} catch (e) {
    console.log(e);
}

// --------------------- body 类型为 raw ------------------
var raw = pm.request.body.raw;
console.log(raw); // 控制台打印参整个 raw 数据

3)常用后置脚本:

pm.test("响应状态码为200", function () {
  pm.response.to.have.status(200);
  pm.expect(pm.response.code).to.eql(200);
});

// GET https://gank.io/api/v2/banners
pm.test("成功响应且有数据", function() {
	pm.expect(pm.response.code).to.eql(200);

    const respJson = pm.response.json();
    pm.expect(respJson.data).to.length.gt(0);
})

// GET https://gank.io/api/v2/data/category/GanHuo/type/iOS/page/1/count/10
pm.test("分页数据满页", function() {
    const respJson = pm.response.json();
    pm.expect(respJson.data.length).to.eq(10);
    pm.expect(respJson.data).to.have.lengthOf(10);
})

// 在脚本中发送请求
pm.sendRequest("https://gank.io/api/v2/banners", function(err, resp) {
    console.log(resp.json())
})

// 响应数据转换
// json
const responseJson = pm.response.json();
// xml
const responseJson = xml2Json(pm.response.text());
// csv
const parse = require('csv-parse/lib/sync');
const responseJson = parse(pm.response.text());
// html https://cheerio.js.org
const $ = cheerio.load(pm.response.text());
console.log($.html());
console.log($(".header"));
// 纯文本
pm.expect(pm.response.text()).to.include("customer_id");
pm.response.to.have.body("whole-body-text");

// 将 jsonData.token 的值写入环境变量
pm.environment.set('token', jsonData.token);

4)常用断言:

// response assertions 示例
pm.test('返回结果没有错误', function() {
  pm.response.to.not.be.error;
  pm.response.to.have.jsonBody('');
  pm.response.to.not.have.jsonBody('error');
});

// pm.response.to.be* 示例
pm.test('返回结果没有错', function() {
  // assert that the status code is 200
  pm.response.to.be.ok; // info, success, redirection, clientError,  serverError, are other variants
  // assert that the response has a valid JSON body
  pm.response.to.be.withBody;
  pm.response.to.be.json; // this assertion also checks if a body  exists, so the above check is not needed
});

// -----------  状态码  -------------
pm.test('Status code is 200', function() {
  pm.response.to.have.status(200);
});
// 检查 HTTP 状态码名称是否包含某个字符串
pm.test('Status code name has string', function() {
  pm.response.to.have.status('Created');
});
// 是否正确的 POST 请求状态码
pm.test('Successful POST request', function() {
  pm.expect(pm.response.code).to.be.oneOf([201, 202]);
});

// --------- 请求头  ---------
pm.expect(pm.response.headers.get('Content-Type')).to.eql('application/json');
pm.test('Content-Type header is present', function() {
  pm.response.to.have.header('Content-Type');
});

// ---------  cookie  ---------
pm.expect(pm.cookies.has('JSESSIONID')).to.be.true;
pm.expect(pm.cookies.get('isLoggedIn')).to.eql('1');

// ---------  响应时间 ms  ---------
pm.test('Response time is less than 200ms', function() {
  pm.expect(pm.response.responseTime).to.be.below(200);
});

// ---------------  请求体验证  -----------------
const jsonData = pm.response.json();
pm.expect(jsonData.name).to.eql("Jane");
// 响应值等于某个预先定义的变量值
pm.expect(jsonData.name).to.eql(pm.environment.get("name"));

// 检查 response body 是否包含某个字符串
pm.test('Body matches string', function() {
  pm.expect(pm.response.text()).to.include('string_you_want_to_search');
});

// 检查 response body 是否包含等于字符串
pm.test('Body is correct', function() {
  pm.response.to.have.body('response_body_string');
});

// 检查 json 值
pm.test('Your test name', function() {
  var jsonData = pm.response.json();
  pm.expect(jsonData.value).to.eql(100);
});

// 断言数据类型
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;

// 数组属性
pm.expect(jsonData.errors).to.be.empty;
pm.expect(jsonData.errors).to.be.an('array').that.is.empty;
pm.expect(jsonData.areas).to.include("goods");
const contactSettings = jsonData.settings.find(m => m.type === "contact");
pm.expect(contactSettings).to.be.an("object", "找不到联系方式配置信息");
pm.expect(contactSettings.detail).to.have.members(["email", "sms"]);

// 对象
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');
pm.expect({a: 1}).to.have.property('a');
pm.expect({a: 1, b: 2}).to.be.an('object').that.has.all.keys('a', 'b');
pm.expect({a: 1, b: 2}).to.deep.include({a:1});	// 包含部分属性
// 集合
pm.expect({"a": 1, "b": 123}.a).to.be.oneOf([1, 123]);

// 字符串
pm.expect('').to.be.empty;

5)脚本里发送请求:

pm.sendRequest('https://postman-echo.com/get', (error, response) => {
  if (error) {
    console.log(error);
  } else {
    console.log(response);
    pm.environment.set('variable_key', 'new_value');
  }
});

// 完整的 request 参数示例
const echoPostRequest = {
  url: 'https://postman-echo.com/post',
  method: 'POST',
  header: {
    headername1: 'value1',
    headername2: 'value2',
  },
  body: {
    mode: 'raw',
    raw: JSON.stringify({ key: 'this is json' }),
  },
};
pm.sendRequest(echoPostRequest, function(err, res) {
  console.log(err ? err : res.json());
});

// 对返回结果进行断言
pm.sendRequest('https://postman-echo.com/get', function(err, res) {
  if (err) {
    console.log(err);
  }
  pm.test('response should be okay to process', function() {
    pm.expect(err).to.equal(null);
    pm.expect(res).to.have.property('code', 200);
    pm.expect(res).to.have.property('status', 'OK');
  });
});

在Runner中运行collection下的请求时, 可以通过postman.setNextRequest(请求名) 或者 postman.setNextRequest(请求id)来指定下一个请求, 这样可以构建起一个调用工作流, 比如先请求数据列表接口, 然后从响应中获取数据id, 再请求数据详情接口. 

原文:postman | Tonny's Blog

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/915010.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

计算机网络常见面试题(一):TCP/IP五层模型、TCP三次握手、四次挥手,TCP传输可靠性保障、ARQ协议

文章目录 一、TCP/IP五层模型&#xff08;重要&#xff09;二、应用层常见的协议三、TCP与UDP3.1 TCP、UDP的区别&#xff08;重要&#xff09;3.2 运行于TCP、UDP上的协议3.3 TCP的三次握手、四次挥手3.3.1 TCP的三次握手3.3.2 TCP的四次挥手3.3.3 随机生成序列号的原因 四、T…

约束(MYSQL)

not null&#xff08;非空&#xff09; unique&#xff08;唯一&#xff09; default&#xff08;默认约束&#xff0c;规定值&#xff09; 主键约束primary key&#xff08;非空且唯一&#xff09; auto_increment&#xff08;自增类型&#xff09; 复合主键 check&#xff08…

Cent OS-7的Apache服务配置

WWW是什么&#xff1f; WWW&#xff08;World Wide Web&#xff0c;万维网&#xff09;是一个全球性的信息空间&#xff0c;其中的文档和其他资源通过URL标识&#xff0c;并通过HTTP或其他协议访问。万维网是互联网的一个重要组成部分&#xff0c;但它并不是互联网的全部。互联…

【C++】类与对象的基础概念

目录&#xff1a; 一、inline 二、类与对象基础 &#xff08;一&#xff09;类的定义 &#xff08;二&#xff09;访问限定符 &#xff08;三&#xff09;类域 &#xff08;四&#xff09;实例化概念 正文 一、inline 在C语言的学习过程中&#xff0c;大家肯定了解过宏这个概…

matlab实现主成分分析方法图像压缩和传输重建

原创 风一样的航哥 航哥小站 2024年11月12日 15:23 江苏 为了研究图像的渐进式传输技术&#xff0c;前文提到过小波变换&#xff0c;但是发现小波变换非常适合传输缩略图&#xff0c;实现渐进式传输每次传输的数据量不一样&#xff0c;这是因为每次变换之后低频成分大约是上一…

python成长技能之网络编程

文章目录 一、初识Socket1.1 什么是 Socket?1.2 socket的基本操作1.3 socket常用函数 二、基于UDP实现客户端与服务端通信三、基于TCP实现客户端与服务端通信四、使用requests模块发送http请求 一、初识Socket 1.1 什么是 Socket? Socket又称"套接字"&#xff0c;…

ROM修改进阶教程------安卓14 安卓15去除app签名验证的几种操作步骤 详细图文解析

在安卓14 安卓15的固件中。如果修改了系统级别的app。那么就会触发安卓14 15的应用签名验证。要么会导致修改的固件会进不去系统,或者进入系统有bug。博文将从几方面来解析去除安卓14 15应用签名验证的几种方法。 💝💝💝通过博文了解: 1💝💝💝-----安卓14去除…

[Docker#6] 镜像 | 常用命令 | 迁移镜像 | 压缩与共享

目录 Docker 镜像是什么 生活案例 为什么需要镜像 镜像命令详解 实验 1.一些操作 1. 遍历查看镜像 2. 查看镜像仓库在本地的存储信息 进入镜像存储目录 查看 repositories.json 文件 3. 镜像过滤 4. 下载镜像时的分层 实战一&#xff1a;离线迁移镜像 实战二&…

「QT」几何数据类 之 QVector3d 三维向量类

✨博客主页何曾参静谧的博客&#x1f4cc;文章专栏「QT」QT5程序设计&#x1f4da;全部专栏「VS」Visual Studio「C/C」C/C程序设计「UG/NX」BlockUI集合「Win」Windows程序设计「DSA」数据结构与算法「UG/NX」NX二次开发「QT」QT5程序设计「File」数据文件格式「PK」Parasolid…

人工智能(AI)对于电商行业的变革和意义

![在这里插入图片描述](https://img-blog.csdnimg.cn/direct/402a907e12694df5a34f8f266385f3d2.png#pic_center> &#x1f393;作者简介&#xff1a;全栈领域优质创作者 &#x1f310;个人主页&#xff1a;百锦再新空间代码工作室 &#x1f4de;工作室&#xff1a;新空间代…

物联网设备研究——分配推理负载的联合学习方法

概述 物联网&#xff08;IoT&#xff09;的最新发展导致人工智能模型被嵌入到传感器和智能手机等终端设备中。这些模型是根据每个设备的存储容量和计算能力定制的&#xff0c;但重点是在终端侧进行本地推理&#xff0c;以降低通信成本和延迟。 然而&#xff0c;与部署在边缘服…

CentOS Stream 9设置静态IP

CentOS Stream 9设置静态IP CentOS Stream 9作为CentOS Stream发行版的下一个主要版本&#xff0c;已经发布有一段时间&#xff0c;但与目前广泛使用的CentOS7有较大区别。安装试用Stream 9的过程中&#xff0c;就发现设置静态IP的方式和CentOS7/8差别较大&#xff0c;在此记录…

【嵌入式】ESP32开发(一)ESP-IDF概述

文章目录 1 前言2 IDF环境配置3 在VS Code中使用IDF3.1 使用ESP-IDF例程3.2 底部按钮的作用【重要!】3.3 高级用法4 ESP-IDF框架分析5 从零开始创建一个项目5.1 组件(component)6 主要参考资料7 遇到的一些问题与解决办法8 对于ESP-IDF开发的一些感受1 前言 对于ESP32的开发…

基于Multisim水箱水位控制系统仿真电路(含仿真和报告)

【全套资料.zip】水箱水位控制系统仿真电路Multisim仿真设计数字电子技术 文章目录 功能一、Multisim仿真源文件二、原理文档报告资料下载【Multisim仿真报告讲解视频.zip】 功能 1.在水箱内的不同高度安装3根金属棒&#xff0c;以感知水位变化情况&#xff0c; 液位分1&…

解读Nature:Larger and more instructable language models become less reliable

目录 Larger and more instructable language models become less reliable 核心描述 核心原理 创新点 举例说明 大模型训练,微调建议 Larger and more instructable language models become less reliable 这篇论文的核心在于对大型语言模型(LLMs)的可靠性进行了深入…

zabbix监控端界面时间与服务器时间不对应

1. 修改系统时间 # tzselect Please select a continent, ocean, "coord", or "TZ".1) Africa2) Americas3) Antarctica4) Asia5) Atlantic Ocean6) Australia7) Europe8) Indian Ocean9) Pacific Ocean 10) coord - I want to use geographical coordina…

ubuntu20.04安装FLIR灰点相机BFS-PGE-16S2C-CS的ROS驱动

一、Spinnaker 安装 1.1Spinnaker 下载 下载地址为&#xff1a; https://www.teledynevisionsolutions.com/support/support-center/software-firmware-downloads/iis/spinnaker-sdk-download/spinnaker-sdk–download-files/?pnSpinnakerSDK&vnSpinnakerSDK 在上述地址中…

Windows配置JDK

1、解压 下载以后解压&#xff0c;放在一个没有中文路径和没有空格的目录&#xff0c;如下图&#xff1a; 2、配置Java环境 1&#xff09;、点击左下角windows图标&#xff0c;输入huanjing&#xff08;或者path&#xff09;&#xff0c;打开环境变量配置 如图&#xff1a; …

Unity教程(十八)战斗系统 攻击逻辑

Unity开发2D类银河恶魔城游戏学习笔记 Unity教程&#xff08;零&#xff09;Unity和VS的使用相关内容 Unity教程&#xff08;一&#xff09;开始学习状态机 Unity教程&#xff08;二&#xff09;角色移动的实现 Unity教程&#xff08;三&#xff09;角色跳跃的实现 Unity教程&…

HCIP-HarmonyOS Application Developer 习题(二十三)

1、&#xff08;多选&#xff09;端云一体化已经集成以下哪些服务SDK。 A、云函数 B、云数据库 C、云存储 D、云托管 答案&#xff1a;AB 分析&#xff1a;云开发即为应用开发云侧工程&#xff0c;目前包含云函数与云数据库工程。 2、&#xff08;多选&#xff09;Entry下的m…