pm域名_pm对象API参考

本文提供了关于pm域名和pm对象API的参考信息。内容涵盖了pm域名的定义、使用场景以及如何通过API与pm对象进行交互。旨在帮助开发者理解和利用pm对象进行项目管理和包管理的相关操作。

pm 对象 API 参考

pm 对象

pm对象是Postman中用于接口测试和脚本编写的核心对象，它提供了丰富的方法和属性，使得用户能够访问和操作接口请求和响应的详细信息，通过pm对象，还可以获取和设置环境变量及全局变量，以及执行异步HTTP请求等操作。

pm.info 对象

pm.info对象包含了接口运行的相关信息，这些信息对于编写动态和自适应的测试脚本非常有用，以下是pm.info对象的常用属性：

pm.info.eventName: 返回当前执行的脚本类型，例如前置脚本（prerequest）或后置脚本（test）。

pm.info.iteration: 返回当前执行的迭代次数（从0开始），仅在集合测试中有效。

pm.info.iterationCount: 返回计划执行的总迭代次数，仅在集合测试中有效。

pm.info.requestName: 返回当前正在运行的接口用例的名称。

pm.info.requestId: 返回当前正在运行的接口用例的唯一ID。

pm.sendRequest 方法

pm.sendRequest是一个功能强大的方法，允许用户在脚本中异步发送HTTP/HTTPS请求，这对于需要进行额外请求或处理复杂逻辑的场景非常有用，该方法接受两个参数：一个兼容Collection SDK的请求对象和一个回调函数，回调函数接收两个参数：一个是错误（如果有的话），另一个是兼容Collection SDK的响应对象。

示例代码

pm.sendRequest({
    url: "https://postmanecho.com/get",
    method: "GET"
}, function(err, res) {
    if (err) {
        console.log(err);
    } else {
        console.log(res.json());
    }
});

pm.variables 对象

pm.variables对象用于管理和操作临时变量，临时变量在当前的请求或测试运行期间有效，具有较高的优先级，pm.variables对象提供以下方法：

pm.variables.has(variableName): 检查是否存在名为variableName的临时变量。

pm.variables.get(variableName): 获取名为variableName的临时变量的值。

pm.variables.set(variableName, variableValue): 设置名为variableName的临时变量的值为variableValue。

pm.variables.replaceIn(variableNa): 用字符串替换指定变量的值，如{{variable_name}}。

pm.environment 对象

pm.environment对象用于访问和操作环境变量，环境变量在不同的请求和测试中保持其值，并可用于实现测试的环境和配置的隔离，主要方法包括：

pm.environment.get(variableName): 获取环境变量variableName的值。

pm.environment.set(variableName, variableValue): 设置环境变量variableName的值为variableValue。

pm.environment.clear(): 清除当前环境中所有变量。

pm.environment.unset(variableName): 删除指定的环境变量variableName。

pm.request 和 pm.response 对象

在前置脚本和后置脚本中，可以通过pm.request和pm.response对象分别访问即将执行的请求和已完成请求的响应，这些对象包含请求和响应的详细信息，如URL、方法、头部和正文等。

pm.request: 提供对即将执行的请求的访问，可以修改请求的各个方面，例如添加或删除头信息。

pm.response: 提供对已完成请求的响应信息的访问，可以获取响应码、状态、头信息和正文内容等。

相关问答FAQs

Q1: 如何在Postman中使用pm.sendRequest发送POST请求？

A1: 使用pm.sendRequest发送POST请求时，需要定义请求对象，其中包含URL、方法、头部和正文信息，示例代码如下：

const postRequest = {
    url: "https://postmanecho.com/post",
    method: "POST",
    header: {
        "ContentType": "application/json"
    },
    body: {
        mode: 'raw',
        raw: JSON.stringify({ key: "value" })
    }
};
pm.sendRequest(postRequest, function(err, res) {
    console.log(err ? err : res.json());
});

Q2: 如何通过pm对象获取和设置环境变量？

A2: 可以通过pm.environment对象的方法来获取和设置环境变量，要获取名为"user"的环境变量的值，可以使用pm.environment.get("user")，要设置该变量的值，可以使用pm.environment.set("user", "new_value")。

下面是一个简化的介绍，用于展示pm域名和pm对象API的参考信息，请注意，实际的API和域名可能依赖于具体的应用程序或服务，以下内容仅作为示例。

API Endpoint Method Description /pm/domain/list GET 获取pm域名的列表 /pm/domain/create POST 创建一个新的pm域名 /pm/domain/update PUT 更新现有的pm域名 /pm/domain/delete DELETE 删除一个pm域名 /pm/object/list GET 获取pm对象的列表 /pm/object/create POST 创建一个新的pm对象 /pm/object/update PUT 更新现有的pm对象 /pm/object/delete DELETE 删除一个pm对象 /pm/object/get GET 获取特定pm对象的信息 /pm/object/search POST 根据条件搜索pm对象

以下是对介绍中每一列的解释：

API Endpoint: 指的是API的端点，即用于访问特定功能的URL路径。

Method: HTTP方法，表示对API端点的请求类型（GET用于检索数据，POST用于提交数据，PUT用于更新数据，DELETE用于删除数据）。

Description: 对API端点的作用和用途的简短描述。

在实际使用中，每个API端点可能还需要传递特定的参数或请求体（payload），具体取决于API的设计和要求，API调用可能需要身份验证和授权令牌，以上介绍仅提供了一个基本的框架，详细的API文档应提供每个端点的详细参数、请求和响应示例以及错误代码等信息。