postman如何用json变量

Postman中JSON变量的灵活运用：提升API测试效率与可维护性**

在API测试的日常工作中,Postman以其强大的功能和易用性赢得了广大开发者和测试人员的青睐，而JSON（JavaScript Object Notation）作为一种轻量级的数据交换格式，在API请求和响应中无处不在，在Postman中，熟练运用JSON变量能够显著提升测试脚本的灵活性、可维护性和复用性，本文将详细介绍在Postman中使用JSON变量的多种方法及其最佳实践。

什么是Postman中的JSON变量？

在Postman中,变量（Variables）是用来存储和复用数据的容器，JSON变量则特指那些存储了JSON格式数据的变量，这些变量可以是一个简单的JSON对象（键值对集合），也可以是一个复杂的JSON结构（包含嵌套对象和数组），使用JSON变量，我们可以将测试数据、请求参数、响应断言中的固定值替换为动态引用，从而实现数据驱动的测试。

JSON变量的主要应用场景

1. 数据驱动测试：将不同的测试数据（如用户登录信息、商品创建数据等）存储在JSON变量中，通过迭代或循环执行测试用例，覆盖多种场景。
2. 动态请求参数：在URL、请求头、请求体（尤其是POST/PUT请求的JSON body）中使用JSON变量，使得请求可以根据前一步的结果或环境变化而动态调整。
3. 响应数据的提取与复用：通过测试脚本（Tests）从上一个请求的响应中提取特定的JSON值，并将其存储为变量，供后续请求使用。
4. 环境与全局配置：将不同环境（如开发、测试、生产）的配置信息（如API基础URL、认证token等）存储为JSON变量，方便环境切换和管理。
5. 复杂断言：在测试断言中，引用JSON变量来验证响应数据是否符合预期，使断言更加灵活和可配置。

在Postman中使用JSON变量的方法

定义JSON变量

JSON变量可以在Postman的多个作用域中定义,其优先级从高到低依次为：Local (局部) > Environment (环境) > Global (全局) > Collection (集合)。

• 在集合/环境/全局变量中定义：

  • 打开你的集合（Collection），点击集合右侧的“...”按钮，选择“Edit”。
  • 在“Variables”标签页下，你可以添加变量。
  • 关键步骤：在“Value”字段中，直接输入JSON格式的字符串，要存储一个用户对象，你可以输入：

    {
    "username": "testuser",
    "password": "password123",
    "email": "test@example.com",
    "profile": {
      "firstName": "Test",
      "lastName": "User",
      "age": 30
    },
    "tags": ["api", "testing", "postman"]
    }

  • 给变量命名,user_data。
  • 环境变量和全局变量的添加方式类似,只需分别进入对应的环境设置或全局设置界面。

• 在Pre-request Script (预请求脚本)或Tests (测试脚本)中动态定义/修改： 你可以使用JavaScript来动态创建或修改JSON变量。

  // 在Pre-request Script或Tests中定义一个新的JSON变量
  pm.environment.set("dynamic_json_var", JSON.stringify({
      "timestamp": Date.now(),
      "request_id": Math.random().toString(36).substring(7),
      "params": {
          "limit": 10,
          "offset": 0
      }
  }));
  // 或者修改已存在的JSON变量（先获取，修改，再设置）
  let existingData = JSON.parse(pm.environment.get("user_data"));
  existingData.profile.age = 31;
  pm.environment.set("user_data", JSON.stringify(existingData));

  注意：Postman的变量存储的是字符串，如果是复杂JSON对象，通常需要使用JSON.stringify()将其转换为字符串存储，使用时再用JSON.parse()解析回来。

在请求中使用JSON变量

• 在URL中使用： 假设你有一个环境变量 api_base_url 值为 "https://api.example.com"，和一个JSON变量 user_data 中的 username。 URL可以设置为：{{api_base_url}}/users/{{user_data.username}} Postman会自动将变量替换为其实际值。

• 在请求头中使用： 使用JSON变量中的token作为Authorization头： Key: Authorization, Value: Bearer {{user_data.token}} (假设user_data中有token字段)

• 在请求体（JSON Body）中使用（最常用）： 这是JSON变量最强大的应用之一，当你发送POST或PUT请求，且请求体是JSON格式时：

  1. 选择“raw”格式，并选择“JSON”。
  2. 直接书写JSON结构,其中需要动态填充的部分使用变量引用。

     {
      "username": "{{user_data.username}}",
      "email": "{{user_data.email}}",
      "profile": {
        "firstName": "{{user_data.profile.firstName}}",
        "lastName": "{{user_data.profile.lastName}}"
      },
      "tags": {{user_data.tags}} // 对于数组或对象，如果变量存储的是已解析的对象，可以直接引用；如果是字符串，需要确保JSON.parse
     }

     重要提示：如果JSON变量（如user_data）在环境中存储的是字符串（通过JSON.stringify设置的），那么在请求体中直接使用{{user_data}}可能会因为引号等问题导致JSON格式错误，更推荐的方式是在Pre-request Script中解析它，或者将JSON的各个叶子节点（如user_data.username）单独定义为变量，如果确实需要在请求体中直接使用整个JSON对象变量，确保该变量在存储时就是有效的JSON对象（Postman在某些情况下会自动处理，但不总是可靠），更稳妥的做法是：

     // 在Pre-request Script中
     pm.environment.set("user_profile_json", JSON.stringify(pm.environment.get("user_data").profile));

     然后在请求体中：

     "profile": {{user_profile_json}}

在Tests (测试脚本)中使用JSON变量

在Tests脚本中,你可以获取变量值，并进行断言或进一步处理。

• 获取JSON变量值：

  // 获取环境变量（假设是字符串形式的JSON）
  let userDataString = pm.environment.get("user_data");
  let userData = JSON.parse(userDataString); // 解析为对象
  // 获取全局变量
  let globalConfig = pm.variables.get("global_config"); // pm.variables.get会按优先级查找
  // 获取集合变量
  let collectionData = pm.collectionVariables.get("collection_data");

• 使用提取的响应数据设置JSON变量： 从登录响应中提取token和用户ID，并存储到JSON变量中：

  const loginResponse = pm.response.json();
  const userInfo = {
      token: loginResponse.token,
      userId: loginResponse.user.id,
      expiresAt: loginResponse.expires_at
  };
  pm.environment.set("auth_info", JSON.stringify(userInfo)); // 存储为字符串

  后续请求就可以通过{{auth_info.token}}来使用token了。

• 断言中使用JSON变量：

  let expectedUserData = JSON.parse(pm.environment.get("user_data"));
  pm.test("Username matches expected", function () {
      pm.expect(pm.response.json().username).to.eql(expectedUserData.username);
  });
  pm.test("User profile age is correct", function () {
      pm.expect(pm.response.json().profile.age).to.eql(expectedUserData.profile.age);
  });

使用JSON变量进行数据驱动测试（通过Collection Runner或Newman）

你可以将测试数据存储在一个JSON文件中（例如data.json），然后在Pre-request Script中读取这个文件（Postman Collection Runner支持直接上传CSV/JSON文件作为数据源），并将数据解析到变量中，供迭代执行。

data.json

[
    {
        "username": "user1",
        "password": "pass1",
        "expectedStatus": 200
    },
    {
        "username": "user2",
        "password": "wrongpass",
        "expectedStatus": 401
    }
]