Postman 脚本参考
pm 对象来访问有关请求、响应和变量的数据。此方法与 Postman 兼容。pm 对象
pm 对象具有以下主要属性。| 属性 | 数据类型 | 描述 |
|---|---|---|
pm.info.eventName | String | 当前正在运行的脚本类型 （预处理器脚本或后处理器脚本）。 |
pm.info.iteration | Number | 当前迭代的次数（仅在测试集合中有效）。 |
pm.info.iterationCount | Number | 总迭代次数（仅在测试集合中有效）。 |
pm.info.requestName | String | 当前正在运行的 API 名称。 |
pm.info.requestId | String | 当前正在运行的 API ID。 |
发送请求（pm.sendRequest）
pm.sendRequest:Functionpm.sendRequest 用于在脚本中发送异步 HTTP/HTTPS 请求。pm.variables
pm.variables:在此查看 Variable SDK 文档。Local Variables > Environment Variables > Global Variables Shared within Project > Global Variables Shared within Team。pm.variables.has(variableName:String):function → Boolean：检查临时变量是否存在。pm.variables.get(variableName:String):function → *：获取临时变量。pm.variables.set(variableName:String, variableValue:String):function → void：设置临时变量。pm.variables.replaceIn(variableName:String):function：将字符串中的“动态变量”（例如 {{variable_name}}）替换为实际值。示例：// Define a string containing a dynamic variable
let stringWithVariable = "Hello, {{username}}";
// Use the replaceIn method to replace the {{username}} placeholder
let realValueString = pm.variables.replaceIn(stringWithVariable);
// Output the replaced value
console.log(realValueString); // Output: "Hello, john_doe"pm.variables.replaceInAsync(variableName:String):function：将字符串中的“动态值表达式”（例如 {{$person.fullName}}）替换为实际值。此方法返回一个 Promise，因此调用时需要使用 await。示例：// Define a string containing a dynamic value expression
let stringWithVariable = "Hello, {{$person.fullName}}";
// Use the replaceInAsync method to replace the {{$person.fullName}}
let realValueString = await pm.variables.replaceInAsync(stringWithVariable);pm.variables.toObject():function → Object：以对象形式获取所有局部变量。pm.iterationData
pm.iterationData:pm.iterationData.has(variableName:String):function → Boolean：检查测试变量是否存在。pm.iterationData.get(variableName:String):function → *：获取测试变量。pm.iterationData.replaceIn(variableName:String):function：将字符串中的动态变量替换为其实际值，例如 {{variable_name}}。pm.iterationData.toObject():function → Object：以对象形式获取所有局部变量。pm.environment
pm.environment.name:String：环境名称。pm.environment.has(variableName:String):function → Boolean：检查环境变量是否存在。pm.environment.get(variableName:String):function → *：获取环境变量。pm.environment.set(variableName:String, variableValue:String):function：设置环境变量。pm.environment.replaceIn(variableName:String):function：将字符串中的动态变量替换为其实际值，例如 {{variable_name}}。pm.environment.toObject():function → Object：以对象形式获取所有局部变量。pm.environment.unset(variableName:String):function：取消设置环境变量。pm.environment.clear():function：清除当前环境下的所有环境变量。pm.moduleVariables
pm.moduleVariables: Objectpm.moduleVariables.has(variableName: String): function → Boolean检查特定模块变量是否存在。
pm.moduleVariables.get(variableName: String): function → *获取特定模块变量的值。
pm.moduleVariables.set(variableName: String, variableValue: String): function设置特定模块变量的值。
pm.moduleVariables.replaceIn(variableName: String): function将字符串中的
{{variable}} 占位符替换为其实际值。pm.moduleVariables.toObject(): function → Object将所有模块变量作为键值对象返回。
pm.moduleVariables.unset(variableName: String): function删除特定模块变量。
pm.moduleVariables.clear(): function清除当前模块中的所有模块变量。
兼容性说明： pm.collectionVariables的工作方式与pm.moduleVariables相同，并且可以互换使用。
pm.globals
pm.globals.has(variableName:String):function → Boolean：检查全局变量是否存在。pm.globals.get(variableName:String，variableScope:String):function → *：获取全局变量。使用 'PROJECT'（默认）或 'TEAM' 指定变量的作用域。pm.globals.set(variableName:String，variableValue:String， variableScope:String):function：设置全局变量。使用 'PROJECT'（默认）或 'TEAM' 指定变量的作用域。pm.globals.replaceIn(variableName:String):function：将字符串中的动态变量替换为其实际值，例如 {{variable_name}}。为了在预处理器脚本中获取包含变量的请求参数的值，请使用 pm.globals.replaceIn将变量替换为真实值。
pm.globals.toObject():function → Object：以对象形式获取所有全局变量。pm.globals.unset(variableName:String，variableScope:String):function：取消设置全局变量。使用 'PROJECT'（默认）或 'TEAM' 指定变量的作用域。pm.globals.clear():function：清除当前环境下的所有全局变量。TIP
1.
current values，不影响initial values。2.
pm.request
pm.request：在此查看 Request SDK 文档。request 是 API 请求对象。在预处理器脚本中，它是将要发送的请求。在后处理器脚本中，它是已经发送的请求。request 包含以下信息：pm.request.url：Url：当前请求的 URL。pm.request.getBaseUrl()：获取当前运行时环境所选的 BASE URL。此功能在 2.1.39 版本之后支持。pm.request.headers：HeaderList：当前请求的头部列表。pm.request.method：String：当前请求的方法，例如 GET、POST 等。pm.request.body： RequestBody：当前请求的主体。pm.request.headers.add({ key: headerName:String, value: headerValue:String}):function：在当前请求中添加一个以 headerName 为键的头部。pm.request.headers.remove(headerName:String):function：在当前请求中删除一个以 headerName 为键的头部。pm.request.headers.upsert({ key: headerName:String, value: headerValue:String}):function：在当前请求中更新或插入一个以 headerName 为键的头部。如果该键已存在，则会被修改。以下 API 只能在 postprocessor scripts中使用。
pm.response
pm.response：在此查看 Response SDK documentation 。pm.response 访问返回的响应信息。pm.response.code:Numberpm.response.status:Stringpm.response.headers：HeaderListpm.response.responseTime:Numberpm.response.responseSize:Numberpm.response.text():Function → Stringpm.response.json():Function → Objectpm.cookies
pm.cookies.has(cookieName:String):Function → Boolean检查 cookieName 的 cookie 值是否存在。
pm.cookies.get(cookieName:String):Function → String从 cookieName 获取 cookie 值。
pm.cookies.toObject:Function → Object以对象形式获取当前域名下的所有 cookie。
pm.cookies.jar().clear(pm.request.url)清除所有 cookie。
TIP
pm.test
done（可选参数）来运行异步测试。pm.test.index():Function → Number获取特定位置的测试总数。
pm.expect
pm.expect 是一种断言方法。在此查看 ChaiJS expect BDD 库文档。pm.response.to.have.*
pm.response.to.have.status(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:String)pm.response.to.have.body(optionalValue:RegExp)pm.response.to.have.jsonBody()pm.response.to.have.jsonBody(optionalExpectEqual:Object)pm.response.to.have.jsonBody(optionalExpectPath:String)pm.response.to.have.jsonBody(optionalExpectPath:String, optionalValue:*)pm.response.to.have.jsonSchema(schema:Object)pm.response.to.have.jsonSchema(schema:Object, ajvOptions:Object)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。
Modified at 2026-06-09 08:55:47