编写测试

测试验证您的 API 是否按预期工作，服务之间的集成是否可靠运行，以及新开发没有破坏任何现有功能。您可以使用 JavaScript 为 Postman API 请求编写测试脚本。当您的 API 项目出现问题时，您还可以使用测试代码来帮助调试过程。例如，您可以编写一个测试，通过发送包含不完整数据或不正确参数的请求来验证 API 的错误处理。

您可以将测试添加到集合中的单个请求、集合和文件夹。Postman 包含您添加然后修改以适合您的测试逻辑的代码片段。

要将测试添加到请求，请打开请求并在“测试”选项卡中输入您的代码。测试将在请求运行后执行。您将能够在响应数据旁边的“测试结果”选项卡中看到输出。

编写测试脚本

测试脚本可以使用动态变量，对响应数据执行测试断言，并在请求之间传递数据。在请求的测试选项卡中，手动输入您的 JavaScript 或使用您将在代码编辑器右侧看到的片段。

收到响应后执行测试。当您选择Send时，Postman 会在响应数据从 API 返回后运行您的测试脚本。

如果您需要在请求运行之前执行代码，请改用Pre-request Scripts。有关在请求运行时脚本如何执行的更多信息，请参阅脚本简介。

验证响应

要验证请求返回的数据，您可以pm.response在测试中使用该对象。使用该函数定义测试pm.test，提供一个名称和函数，该函数返回一个布尔 (true或false) 值，指示测试是通过还是失败。在你的断言中使用ChaiJS BDD语法pm.expect来测试响应细节。

该.test函数的第一个参数是一个文本字符串，它将出现在测试结果输出中。使用它来识别您的测试，并将测试的目的传达给查看结果的任何人。

例如，在请求的“测试”选项卡中输入以下内容以测试响应状态代码是否为200：

pm.test("Status test", function () {
    pm.response.to.have.status(200);
});

选择发送以运行您的请求并在响应部分打开测试结果。选项卡标题显示通过了多少测试以及总共运行了多少。您还可以在通过、跳过和失败的测试结果之间切换。

如果请求返回200状态码，则测试通过。尝试更改测试脚本中的预期状态代码并再次运行请求。

使用 pm.expect 格式化测试结果消息

使用该pm.expect语法可为您的测试结果消息提供不同的格式。尝试替代方案以实现您认为最有用的输出。

使用Intro to writing tests 集合中的Run in Postman按钮将包含一些示例测试脚本的模板导入 Postman 并试验代码。

您的代码可以测试请求环境，如下例所示：

pm.test("environment to be production", function () {
    pm.expect(pm.environment.get("env")).to.equal("production");
});

您可以使用不同的语法变体以您认为可读且适合您的应用程序和测试逻辑的方式编写测试。

pm.test("response should be okay to process", function () {
    pm.response.to.not.be.error;
    pm.response.to.have.jsonBody("");
    pm.response.to.not.have.jsonBody("error");
});

您的测试可以使用您为响应数据格式定制的语法来确定请求响应的有效性。

pm.test("response must be valid and have a body", function () {
     pm.response.to.be.ok;
     pm.response.to.be.withBody;
     pm.response.to.be.json;
});

您的脚本可以包含您需要的任意数量的测试，并且在您选择Save时将与您的其余请求详细信息一起保存。如果您共享一个集合、发布文档或使用在 Postman 中运行按钮，您的测试代码将包含在任何查看或导入您的模板的人中。

使用片段

测试编辑器右侧的代码段中有一系列常用的测试代码摘录。选择一个，它将插入到您的编辑器中。片段可以加快开始使用脚本的过程。您可以在添加片段后对其进行编辑以满足您自己的测试要求。

测试集合和文件夹

您可以将测试脚本添加到集合、文件夹或集合中的单个请求。与集合关联的测试脚本将在集合中的每个请求之后运行。与文件夹关联的测试脚本将在文件夹中的每个请求之后运行。这使您能够在每次请求后重用通常执行的测试。

将脚本添加到集合和文件夹使您能够测试 API 项目中的工作流。这有助于确保您的请求涵盖典型场景，为应用程序用户提供可靠的体验。

您可以通过选择集合或文件夹名称旁边的三个点并选择Edit来更新集合和文件夹脚本。选择测试选项卡以添加或更新您的脚本。您还可以在首次创建集合时添加集合脚本。

运行集合时，您将看到集合运行器输出的测试结果。

您可以编写脚本来使用分支和循环来控制请求的运行顺序。

下一步

查看一些测试脚本示例和Postman Sandbox API 参考，了解您可以使用该pm对象做什么。

将测试与其他 Postman 实用程序（例如监控）结合使用，可以让您验证您的 API 是否满足性能要求。您还可以通过在CI/CD 配置中集成收集运行来自动化您的测试。