如何使用 Postman 创建一个通用的环境请求模板？

techbird

0/5 (0投票)

2018 年 7 月 5 日

CPOL

5分钟阅读

12782

借助 Postman 的 Environment 功能，跨多个环境管理 Postman 请求。

Postman Collection 和 Environments zip

引言

Postman 是最受欢迎的 REST API 客户端之一，它为 API 开发提供了一个完整的流程。在本文中，我们将讨论 Postman Environment 及其优点。

当我们想要管理不同环境的 API 请求时，我们需要为不同环境创建单独的 Postman 集合，这非常痛苦，

当每次迭代 API 函数的数量都会增加时
当我们想要更改所有环境中现有请求的详细信息时。

幸运的是，Postman Environment 功能解决了上述所有维护问题，并帮助我们创建可以在多个环境（例如 Development、QA 等）中使用的请求模板，而无需为每个环境创建单独的集合。

先决条件

要跟随本文，您需要以下内容：

HTTP 协议基础知识
Postman 基础知识
Postman 桌面应用程序。如果您还没有安装，可以从 www.getpostman.com 获取。

什么是 Postman 变量？

要更好地理解 Postman Environment，我们需要理解 Postman 变量。Postman 变量是键值对，类似于字典项。键是变量的名称，值是变量的实际值。Postman 使用双花括号语法来表示变量。Postman 将在运行时（在将请求发送到服务器之前）将其替换为实际值。

Syntax:

{{variable}}

什么是 Postman Environment？

Postman Environment 代表 API/服务主机/运行时环境，如 Dev、QA 等。它包含一个或多个具有独立作用域的 Postman 变量。我们可以在任何请求部分（如 URL、标头和正文）中使用这些变量来创建环境通用请求模板。

示例场景

假设您有一个用于产品管理的 API，它提供了各种产品管理 API 函数。我们将使用产品详细信息 API 函数进行演示。

产品详细信息 API

Verb: GET

Url: https://www.products.com/api/v1/products/<product id>

Headers:

x-api-key: <api key>

示例

https://www.products.com/api/v1/products/2

由于上述 API 实际上并不存在，我将使用 httpbin.org 来演示 Postman Environment 的工作原理。Httpbin.org 提供了一系列 HTTP echo API，它会在 HTTP 响应中返回请求详细信息，因此它是理解 Postman Environment 的正确选择。

要使用 Postman Environment，我们需要执行以下主要步骤：

从 API/服务请求中识别特定于环境的元素
为每个 API 主机/运行时环境创建 Postman Environment。
在 Environment 中为步骤 1 中识别的每个特定于环境的元素创建一个变量
借助新创建的 Environment 创建一个环境通用请求模板。
跨多个环境运行您的请求。

根据我们上面的产品 API 示例，我们可以说域和 API 密钥将根据环境而变化，因此我们可以在 Environment 中创建 host 和 api_key 变量。

如何创建 Postman Environment？

按照以下步骤创建 Environment：

打开 Postman 桌面应用程序。打开后，您会在 Postman 窗口的右上角找到一个小的设置图标。单击设置图标。
将打开“管理 Environment”弹出窗口，当您第一次打开时，它将显示一个空列表。
单击帮助文本中的“创建 Environment”链接或弹出窗口底部的“添加”按钮。
将打开“添加 Environment”表单。首先，您需要输入 Environment 名称，然后输入所需的变量名称和值。
根据我们的示例，按照以下步骤创建 Environment：
- 在 Environment 名称字段中输入 Development。
- 在第一行的“新键”字段中键入 host，在值字段中键入 dev.products.com。
- 在第二行的“新键”字段中键入 api_key，在值字段中键入 xxxxxxxxxx-dev-xxxxxxxxxx。
- 单击“添加”按钮。
- 它将返回到“管理 Environment”弹出窗口。现在，列表中将列出新创建的 Development Environment。
- 为了更好地理解 Postman Environment 功能，我们需要创建至少一个额外的 Environment。这次我们不需要从头开始创建 Environment。我们可以使用“复制 Environment”选项。
- 单击 Development Environment 行中的“复制 Environment”图标。
- 单击 Development Copy Environment。
- 将 Environment 名称更改为 QA。
- 将 host 值更改为 qa.products.com。
- 将 api_key 值更改为 xxxxxxxxxx-qa-xxxxxxxxxx。
- 单击“更新”按钮。
- 它将返回到“管理 Environment”弹出窗口。现在您可以看到 Development 和 QA Environment。

创建完所需的 Environment 后，关闭“管理 Environment”窗口。

如何创建 Postman Environment 通用请求模板？

现在，我们准备好使用新创建的 Postman Environment 来创建环境通用模板。请按照以下步骤创建请求模板。

从 Environment 下拉菜单中选择 Development。
在 URL 字段中键入 https://httpbin.org/get/?url=https://{{host}}/api/v1/products/2。您会注意到，一旦您输入双花括号，Postman 就会显示变量智能提示，您可以从中选择所需的变量。
转到“Headers”选项卡。在键字段中键入 x-api-key，在值字段中键入 {{api_key}}。
现在我们准备好测试我们的请求了，在此之前，我们需要打开 Postman 控制台来查看请求日志。
单击 View -> Show Postman Console 或按 Alt + Ctrl + C。这将打开 Postman 控制台并将其放在一边。
单击“发送”按钮将请求发送到 httpbin.org API。
转到 Postman 控制台查看请求日志。如果您可以看到 Postman 在 URL 和标头部分将所有变量替换为实际值。
返回 Postman 主窗口查看 httpbin.org 响应。它也证实了我们在控制台窗口中看到的结果。
您可以通过更改 Environment 来重用相同的请求来处理不同的 Environment。
要切换到另一个 Environment，您需要更改 Environment 下拉菜单。将 Environment 更改为 QA，就是这样，现在您可以在不同的 Environment 中运行相同的请求。