网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

pm对象API参考

更新时间:2024-06-04 GMT+08:00
分享

pm

pm:Object

pm对象,含有接口运行关联信息。可利用它获取或设置环境变量和全局变量,且访问请求信息和返回结果信息。

pm:info:Object

pm.info对象,含有接口运行关联信息。

  • pm.info.eventName:String:获取当前执行的脚本类型:前置脚本(prerequest),后置脚本(test)。
  • pm.info.iterationCount:Number:返回执行循环的总次数,仅集合测试有效。
  • pm.info.iteration:Number:获取当前执行循环(iteration)次序,仅集合测试有效。
  • pm.info.requestId:String:获取运行中接口用例的唯一ID。
  • pm.info.requestName:String:获取运行中接口用例名称。

对于变量的处理

pm.variables

临时变量,Variable SDK 参考

  • pm.variables.toObject():function:获取所有临时变量,结果以对象形式返回。
  • pm.variables.has(variableName:String):function:检查某个临时变量是否存在。
  • pm.variables.get(variableName:String):function:获取某个临时变量。
  • pm.variables.set(variableName:String, variableValue:String):function:设置某个临时变量的名称和值。
  • pm.variables.replaceIn(variableName:String):function:用字符串替换指定变量的值,如{{variable_name}}。

pm.environment​

环境变量。

  • pm.environment.name:String:获取环境名称。
  • pm.environment.toObject():function:获取当前环境的所有的变量,结果以对象形式返回。
  • pm.environment.clear():function:清除当前环境中所有变量。
  • pm.environment.has(variableName:String):function:检查某个环境变量是否存在。
  • pm.environment.get(variableName:String):function:获取某个环境变量。
  • pm.environment.set(variableName:String, variableValue:String):function:设置某个环境变量的名称和值。
  • pm.environment.replaceIn(variableName:String):function:用字符串替换指定变量的值,如{{variable_name}}。
  • pm.environment.unset(variableName:String):function:删除某个环境变量。

对于不同类型变量的优先级顺序为: 临时变量 > 环境变量。

说明:

以上所有操作都是对本地值进行读写,而不会访问远程值。

对于请求的处理

pm.request​

pm.request对象可以在脚本中对请求数据进行访问,Request SDK 参考。在前置脚本中表示即将运行的请求,在后置脚本中,表示已经运行的请求。

pm.request包含了以下结构:

  • pm.request.url:Url:获取当前请求的URL。
  • pm.request.getBaseUrl():获取运行中环境选择的前置URL。
  • pm.request.method:String:获取当前请求的方法,如GET、POST等。
  • pm.request.headers:HeaderList:获取当前请求的headers列表。
  • pm.request.body:RequestBody:获取当前请求的body体。
  • pm.request.headers.add({ key: headerName:String, value: headerValue:String}):function:为当前请求添加指定键和值的header。
  • pm.request.headers.remove(headerName:String):function:删除当前请求里指定键的header。
  • pm.request.headers.get(headerName:String):function:获取请求里指定名称的header。
  • pm.request.headers.upsert({ key: headerName:String, value: headerValue:String}):function:插入指定键和值的header(如果header不存在则新增,如果header已存在则修改)。
  • pm.request.auth:获取请求的身份验证信息。

对于响应的处理

pm.response​

在后置脚本中pm.response接口请求完成后返回响应信息,Response SDK 参考

response包含了以下结构:

  • pm.response.code:Number:获取响应码。
  • pm.response.status:String:获取响应状态。
  • pm.response.headers:HeaderList:获取响应头。
  • pm.response.responseSize:Number:获取响应大小。
  • pm.response.text():Function:以文本形式输出响应体。
  • pm.response.json():Function:以json形式输出响应体。
  • pm.response.setBody(''):设置响应体。
  • pm.response.headers.get:从响应头中获取指定参数的值,Response SDK 参考

后置脚本中使用“pm.response.headers.get”命令可以获取响应头中指定参数的值。例如想要获取响应Header中date参数的值,那么可以在后置操作中输入如下自定义脚本:

var test = pm.response.headers.get("date");
console.log(test);

对于断言的处理

pm.test​

  • pm.test(testName:String, specFunction:Function):Function:断言某项结果是否符合预期。

以下示例检查返回响应是否正确:

pm.test("response should be OK to process", function() {
  pm.response.to.not.be.error;
  pm.response.to.have.jsonBody("");
  pm.response.to.not.have.jsonBody("error");
});

通过回调可选参数done,可用来测试异步方法:

pm.test("async test", function(done) {
  setTimeout(() => {
    pm.expect(pm.response.code).to.equal(200);
    done();
  }, 1500);
});
  • pm.test.index():Function:获取特定位置的测试总数。

pm.expect​

  • pm.expect(assertion:*):Function:一个普通的断言方法,详细的说明请参照ChaiJS expect BDD library。该方法对于处理来自响应response或变量variables的数据断言非常有用,更多关于pm.expect断言的示例,请参见Assertion library examples

Response 对象的断言API列表​

  • pm.response.to.have.status(code:Number):判断响应状态码是否为设置的(code:Number)。
  • pm.response.to.have.status(reason:String):判断响应状态码是否符合响应码描述。
  • pm.response.to.have.header(key:String):判断是否包含响应头中对应的键。
  • pm.response.to.have.header(key:String, optionalValue:String):判断是否包含响应头中对应的键、值。
  • pm.response.to.have.body():判断是否有响应体。
  • pm.response.to.have.body(optionalValue:RegExp):判断响应体中是否等于设置的正则表达式。
  • pm.response.to.have.body(optionalValue:String):判断响应体中是否等于设置的字符串。
  • pm.response.to.have.jsonBody():判断响应体是否是有效的json结构。
  • pm.response.to.have.jsonBody(optionalExpectEqual:Object):判断响应体是否等于json结构里设置的对象。
  • pm.response.to.have.jsonBody(optionalExpectPath:String):判断响应体是否包含json结构里设置的路径。
  • pm.response.to.have.jsonBody(optionalExpectPath:String, optionalValue:*):

    判断响应体是否包含json结构里设置的路径,且路径是否等于设置的值。

  • pm.response.to.have.jsonSchema(schema:Object):判断响应体是否满足定义的json模型。
  • pm.response.to.have.jsonSchema(schema:Object, ajvOptions:Object):判断响应体是否满足定义的json模型、校验配置。

pm.response.to.be​

pm.response.to.be是一系列内置规则用于实现快速断言。

  • pm.response.to.be.info:检查状态码是否为1XX。
  • pm.response.to.be.success:检查状态码是否为2XX。
  • pm.response.to.be.redirection:检查状态码是否为3XX。
  • pm.response.to.be.clientError:检查状态码是否为4XX。
  • pm.response.to.be.serverError:检查状态码是否为5XX。
  • pm.response.to.be.error:检查状态码是否为4XX或5XX。
  • pm.response.to.be.ok:检查状态码是否为200。
  • pm.response.to.be.accepted:检查状态码是否为202。
  • pm.response.to.be.badRequest:检查状态码是否为400。
  • pm.response.to.be.unauthorized:检查状态码是否为401。
  • pm.response.to.be.forbidden:检查状态码是否为403。
  • pm.response.to.be.notFound:检查状态码是否为404。
  • pm.response.to.be.rateLimited:检查状态码是否为429。

对于发送请求的处理

pm.sendRequest

pm.sendRequest:Function用于脚本异步发送HTTP/HTTPS的请求。

// 使用字符串URL示例
pm.sendRequest("https://postman-echo.com/get", function(err, resq) {
  if (err) {
    console.log(err);
  } else {
    pm.variables.set("variable_name", "new_value");
  }
});

// 完整请求示例
const echoPostRequest = {
  url: "https://postman-echo.com/post",
  method: "POST",
  header: {
    header_name1: "value1",
    header_name2: "value2",
  },
  // body 为 x-www-form-urlencoded 格式
  body: {
    mode: "urlencoded", // 此处为 urlencoded
    // 此处为 urlencoded
    urlencoded: [
      { key: "account", value: "codeartsapi" },
      { key: "password", value: "123456" },
    ],
  },
  /*
  // body 为 form-data 格式
  body: {
    mode: 'formdata', // 此处为 formdata
    // 此处为 formdata
    formdata: [
      { key: 'account', value: 'codeartsapi' },
      { key: 'password', value: '123456' }
    ]
  }
  // body 为 json 格式
  header: {
    "Content-Type": "application/json", // 提醒:header中需要添加Content-Type
  },
  body: {
    mode: 'raw',
    raw: JSON.stringify({ account: 'codeartsapi', password:'123456' })
  }
  // body 为 raw 或 json 格式
  body: {
    mode: 'raw',
    raw: 'body内容'
  }
  */
};
pm.sendRequest(echoPostRequest, function(err, resq) {
  console.log(err ? err : resq.json());
});

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

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容