Postman 脚本入门指南

在当今的应用程序开发环境中，有个强大高效的 API 调试工具至关重要。其中，Postman 是目前最流行的 API 工具，提供了用于构建和执行 API 请求的强大工具集。

🦊

如果觉得 Postman 过于复杂难以上手，或者不适应使用纯英文软件，可以考虑尝试使用 Apifox，国内流行的的 API 开发工具，支持中文，覆盖 API 开发全程流程，上手超级简单，优先考虑新手和经验丰富的开发人员的简单性和直观性。可以点击下方的按钮开始使用 Apifox 构建、测试、模拟和记录 API。

下载最新版 Apifox

Postman Scripts 用 JavaScript 编写，使用户能够自动化复杂的工作流程并增强 API 测试。本文将深入研究 Postman 脚本示例，介绍它对于简化和加强 API 测试流程的功能和优势。

Postman 脚本的作用

Postman 脚本是用 JavaScript 编写的，允许开发人员在应用程序上启用自动化和动态行为：

自动执行重复性任务

每次都使用略有不同的参数手动测试大量 API，是非常耗费时间且消耗人力的。使用 Postman 脚本可以解决这个难题，可以编写脚本来根据预定义的条件自动调整请求参数、Header 或 URL，从而节省大量时间和精力。

动态请求构建

静态请求有其适用的场景，但 API 通常需要动态调整。Postman脚本可以即时构建请求。例如，一个脚本可以为每个请求生成唯一的数据，或者从外部资源中获取数据以创建自定义的测试场景。

更强的数据处理能力

验证 API 响应至关重要。Postman 脚本能够比表面级别的检查进行更深入的研究，支持编写脚本来解析复杂的 JSON 响应、提取特定数据点并将其与预期值进行比较，确保 API 返回正确的数据结构和内容。

条件逻辑和工作流程

API 测试通常涉及具有分支路径的复杂场景。Postman 脚本允许合并条件逻辑，根据响应代码或提取的数据，通过脚本可以确定下一步的操作，例如发送后续请求或跳过某些测试，构建适应不同 API 行为的强大测试工作流程。

集成和可重用性

Postman 脚本与其他功能（例如集合和环境）无缝集成。脚本可以利用环境变量来存储可重用的数据，进一步增强其灵活性。此外，为一个请求编写的脚本通常可以适用于其他请求，从而促进代码重用并减少开发时间。

Postman 脚本示例

举一些开发人员可能在 API 请求中使用的一些 Postman 脚本代码片段示例：

自动请求参数

// Get the current timestamp and add it to the request body
pm.request.body.put("timestamp", pm.timestamp());
// Access an environment variable and use it in the URL
pm.environment.get("baseURL") + "/users/" + pm.variable("userId");

动态请求构建

// Loop through an array of user IDs and send a GET request for each
pm.collectionVariables.forEach(function(variable) {
  pm.sendRequest({
    url: pm.environment.get("baseURL") + "/users/" + variable.value,
    method: "GET"
  });
});
// Generate random data for a POST request
pm.request.body.put("name", pm.faker.name.findName());
pm.request.body.put("email", pm.faker.internet.email());

验证响应数据

// Check response status code
pm.test("Status code is 200", function() {
  pm.response.to.have.status(200);
});
// Extract a specific value from JSON response and compare it
const jsonData = pm.response.json();
pm.expect(jsonData.id).to.equal(123);

基于响应的条件逻辑

// If status code is 404, skip subsequent tests
pm.test("Check response status", function() {
  if (pm.response.to.have.status(404)) {
    pm.test.skip("API endpoint not found, skipping further tests");
  } else {
    // Perform additional tests here
  }
});

使用 Apifox 轻松构建脚本

当然，你也可以借助工具来实现脚本，会更容易。比如 Apifox 这个综合性 API 开发平台，为用户提供适用于整个 API 生命周期的完整工具。

借助 Apifox，你可以在单个应用程序中构建、测试、模拟和记录 API，不再需要为其他应用程序切换窗口，非常方便。

将 API 导入 Apifox 进行修改

将 API 导入到 Apifox 中，迈出完善 API 的第一步。 Apifox 支持各种 API 文件类型，包括 OpenAPI（Swagger）、Postman 和 Insomnia 等 20 多种。

点击「项目设置 - 导入数据」，选择你需要的类型，拖入文件或者填写 URL 即可，非常简单。

在 Apifox 中添加自定义脚本

完成 API 导入或在 Apifox 上创建新项目后，你可以继续添加自定义脚本。

在 API 的修改文档部分，找到「后置操作」。选择添加「自定义脚本」，可以在此处为 API 请求实施自定义脚本，还可以选择右侧的“代码片段”选项选择自己需要的代码一键套用。

使用 Apifox 生成 API 文档

当你完成了项目，就可以创建文档，这个时候你就可以依靠 Apifox 来完成这项工作。

选择 Apifox 应用程序窗口左侧的「分享文档」按钮，就能够看到“共享文档”页面，该页面应该是空的。选择「新建分享」按钮开始创建你的 Apifox API 文档。

选择 API 文档属性

通过 Apifox 分享文档时，开发人员可以根据提供的选项为 API 文档勾选需要分享的范围、接口运行环境、解扣子韩式内容。以及谁可以查看的你 API 文档并设置文件密码，以便只有选定的个人或组织才能查看它。

查看或分享 API 文档

一旦 API 文档被设置视为「公开」，就可以对它进行共享、编辑或删除等操作，具体取决于你的需求。

总结

Postman 脚本将 API 测试从死记硬背的过程提升为战略性且高效的工作。通过自动化任务、构建动态请求和仔细验证响应，使我们能够实现更高水平的测试覆盖率，同时与其他 Postman 功能的集成和可重用性潜力简化了开发和维护。

随着 API 格局的发展，Postman 脚本成为确保 API 持续健康和可靠性的宝贵工具。当然，国内也有越来越多好用的工具来替代 Postman 使用，比如免费的 Apifox，找到适合自己的工具，对你的 API 开发过程更友好。