Postman：Postman API测试：Postman预请求脚本编写

Postman：Postman API测试：Postman预请求脚本编写

Postman基础介绍

Postman软件概述

Postman是一款强大的API开发工具，它允许开发者构建、测试、修改和发布API。Postman不仅简化了API测试的过程，还提供了丰富的功能，如环境变量、集合、预请求脚本和测试脚本，使得API的开发和维护变得更加高效和便捷。

主要功能

• 构建请求：Postman支持多种HTTP请求方法，包括GET、POST、PUT、DELETE等，用户可以轻松构建复杂的HTTP请求。
• 测试API：内置的测试功能可以自动验证API响应，确保API按预期工作。
• 预请求脚本：在发送请求前执行的脚本，可以动态修改请求参数，如生成随机数、设置请求头等。
• 环境变量：允许用户在不同环境中（如开发、测试、生产）使用相同的集合，通过切换环境变量来调整请求参数。
• 集合：用于组织和管理多个相关请求，方便进行批量测试或分享给团队成员。
• 监控和集成：Postman可以与各种工具和服务集成，如GitHub、Jenkins等，支持持续集成和监控API性能。

API测试的重要性

API（Application Programming Interface）测试是软件测试中的一种类型，主要针对API的功能、性能、安全性和兼容性进行验证。API测试的重要性在于：

• 确保功能正确性：API测试可以验证API是否按预期返回正确的数据和状态码。
• 提高测试效率：与UI测试相比，API测试通常更快，因为它直接与后端交互，不需要等待页面加载。
• 易于自动化：API测试易于自动化，可以频繁运行，确保每次代码更改后API仍然正常工作。
• 早期发现缺陷：API测试可以在UI开发之前进行，帮助早期发现和修复缺陷，减少后期修复成本。
• 支持集成测试：API测试可以作为集成测试的一部分，验证不同系统或服务之间的交互是否正常。

Postman在API测试中的角色

Postman在API测试中扮演着至关重要的角色，它不仅提供了构建和发送HTTP请求的工具，还集成了测试脚本、环境管理、数据生成等功能，使得API测试变得更加全面和高效。

预请求脚本编写

预请求脚本是在发送API请求前执行的JavaScript代码，可以用来动态修改请求参数、设置环境变量、生成随机数据等。下面是一个简单的预请求脚本示例，用于在发送请求前生成一个随机的用户ID：

// 生成一个随机的用户ID
var randomUserId = Math.floor(Math.random() * 1000) + 1;
pm.environment.set("userId", randomUserId);

在这个示例中，我们使用了JavaScript的Math.random()函数来生成一个0到1之间的随机数，然后将其乘以1000并向下取整，得到一个0到999之间的整数。最后，我们通过pm.environment.set()函数将这个随机数设置为环境变量userId，这样在发送请求时，就可以使用这个动态生成的用户ID了。

测试脚本

测试脚本是在收到API响应后执行的JavaScript代码，用于验证API的响应是否符合预期。下面是一个测试脚本示例，用于检查API响应的状态码是否为200，并验证响应体中是否包含特定的字符串：

// 检查响应状态码
pm.test("Status code is 200", function () {
   
   
    pm.response.to.have.status(200);
});

// 验证响应体中是否包含特定字符串
pm.test("Response contains 'Hello, World!'", function () {
   
   
    pm.response.to.have.body("Hello, World!");
});

在这个示例中，我们使用了Postman内置的pm.test()函数来定义测试用例。第一个测试用例检查响应状态码是否为200，第二个测试用例则验证响应体中是否包含字符串“Hello, World!”。通过这些测试脚本，可以确保API的响应符合预期，从而提高API测试的准确性和可靠性。

环境变量

环境变量是Postman中用于存储和管理变量的一种机制，可以用来区分不同的测试环境，如开发环境、测试环境和生产环境。下面是一个环境变量的使用示例，用于在不同的环境中切换API的URL：

// 根据环境变量设置API URL
var url = pm.environment.get("apiUrl");
pm.sendRequest(url, function (err, res) {
   
   
    // 处理响应
});

在这个示例中，我们使用pm.environment.get()函数来获取环境变量apiUrl的值，然后将其设置为API的URL。这样，在不同的环境中，只需要修改环境变量apiUrl的值，就可以自动切换API的URL，而无需修改请求本身，大大提高了API测试的灵活性和效率。

集合

集合是Postman中用于组织和管理多个相关请求的一种方式，可以方便地进行批量测试或分享给团队成员。下面是一个集合的使用示例，用于组织和管理一个用户登录和获取用户信息的API测试：

- **登录API测试**
  - 请求方法：POST
  - 请求URL：https://api.example.com/login
  - 请求参数：username, password
  - 预请求脚本：设置环境变量`token`为登录后返回的token
  - 测试脚本：验证状态码为200，响应体中包含`token`

- **获取用户信息API测试**
  - 请求方法：GET
  - 请求URL：https://api.example.com/user
  - 请求头：Authorization: Bearer {
  
  {token}}
  - 测试脚本：验证状态码为200，响应体中包含`username`和`email`

在这个示例中，我们创建了一个包含两个请求的集合，第一个请求用于用户登录，第二个请求用于获取用户信息。在登录请求中，我们使用预请求脚本来设置环境变量token，这样在获取用户信息的请求中，就可以使用这个token来设置请求头，实现API的鉴权。通过这种方式，可以将多个相关请求组织在一起，形成一个完整的API测试流程，提高API测试的效率和准确性。

总结

Postman是一款功能强大的API开发和测试工具，它提供了预请求脚本、测试脚本、环境变量和集合等功能，使得API测试变得更加全面和高效。通过合理使用这些功能，可以构建出灵活、可重复和自动化的API测试流程，从而提高API的开发和维护效率，确保API的稳定性和可靠性。

预请求脚本概念与作用

什么是预请求脚本

预请求脚本是Postman提供的一种功能，允许在发送请求之前执行JavaScript代码。这使得测试人员和开发人员能够在请求发送到服务器之前，动态地修改请求的任何部分，包括URL、headers、body等。预请求脚本的使用极大地增强了Postman的灵活性和功能，特别是在处理复杂的API测试场景时。

预请求脚本的用途

预请求脚本可以用于多种场景，包括但不限于：

• 动态生成请求参数：例如，使用当前时间戳作为请求的一部分，或者基于其他请求的结果生成参数。
• 设置请求头：可以动态设置或修改请求头，如添加认证信息或设置Content-Type。
• 修改请求体：在发送请求前，根据需要修改请求体中的数据。
• 执行HTTP请求：预请求脚本中可以执行额外的HTTP请求，例如获取API密钥或刷新令牌。

预请求脚本与测试流程的结合

预请求脚本在API测试流程中扮演着关键角色，它可以在测试执行的早期阶段进行数据准备或环境设置，确保每个请求在正确的上下文中被发送。例如，如果API需要一个特定的认证令牌，预请求脚本可以负责在每次测试运行前刷新这个令牌，从而避免了手动更新或硬编码令牌的需要。

示例：动态生成请求参数

假设我们正在测试一个API，该API需要一个时间戳作为查询参数。我们可以使用预请求脚本来动态生成这个时间戳。

// 生成当前时间戳
var timestamp = new Date().getTime();

// 将时间戳添加到请求的URL中
pm.request.url.addQueryParams({
   
    "timestamp": timestamp });

示例：设置请求头

如果API需要一个特定的认证头，例如一个JWT令牌，我们可以使用预请求脚本来设置这个头。

// 假设我们已经有一个JWT令牌存储在Postman的环境变量中
var jwtToken = pm.environment.get("JWT_TOKEN");

// 设置请求头
pm.request.headers.add({
   
   
    key: "Authorization",
    value: "Bearer " + jwtToken,
    type: "text"
});

示例：修改请求体

在某些情况下，我们可能需要在发送请求前修改请求体中的数据。例如，如果请求体是一个JSON对象，我们可能需要在每次测试运行时更新其中的某个字段。

// 假设请求体是一个JSON对象，存储在pm.request.body中
var requestBody = pm.request.body;

// 将请求体转换为JSON对象
var requestBodyJson = JSON.parse(requestBody);

// 修改JSON对象中的某个字段
requestBodyJson.user.id = 12345;

// 将修改后的JSON对象转换回字符串，并设置为请求体
pm.request.body = JSON.stringify(requestBodyJson);

示例：执行HTTP请求

预请求脚本中也可以执行HTTP请求，例如，我们可能需要在发送主请求前，先从另一个API获取一些数据。

// 执行一个HTTP GET请求
var myRequest = {
   
   
    method: 'GET',
    url: 'https://api.example.com/data',
    headers: {
   
   
        'Content-Type': 'application/json'
    }
};

pm.sendRequest(myRequest, function (err, res) {
   
   
    if (err) {
   
   
        console.error(err);
    } else {
   
   
        // 假设响应中包含一个我们需要的字段
        var data = res.json();
        pm.environment.set("myData", data.myField);
        
        // 将获取的数据添加到请求的URL中
        pm.request.url.addQueryParams({
   
    "data": pm.environment.get("myData") });
    }
});

通过这些示例，我们可以看到预请求脚本如何增强Postman的功能，使其能够处理更复杂的API测试需求。预请求脚本的编写和使用，是API测试中一个重要的技能，能够显著提高测试的效率和准确性。

编写预请求脚本

使用Postman内置函数

在Postman中，预请求脚本是在发送请求之前运行的脚本，用于设置请求的环境，如生成动态数据、修改请求头或URL参数。Postman提供了丰富的内置函数，可以帮助你更高效地编写预请求脚本。

生成动态数据

// 使用内置函数生成随机数，用于动态数据
const randomId = pm.random.text(10);
pm.environment.set("dynamicId", randomId);

这段脚本使用pm.random.text(10)生成一个10位的随机字符串，并将其设置为环境变量dynamicId。在请求的URL或参数中，你可以使用{ {dynamicId}}来引用这个变量，从而实现动态数据的请求。

修改请求头