Postman环境变量与API开发工作流

在API开发过程中,维护不同环境下的API请求是一个常见的挑战。随着API功能的不断增加,手动管理每个环境的请求细节变得繁琐且容易出错。幸运的是,Postman环境变量功能可以帮助解决这些问题,它允许创建可在多个环境(如开发、测试等)中使用的请求模板,而无需为每个环境创建单独的集合。

要理解Postman环境变量的好处,首先需要了解一些基本概念。HTTP协议的基础知识和Postman的基本操作是必要的前提条件。如果还没有安装Postman桌面应用程序,可以从下载。

什么是Postman变量?
Postman变量是一个键值对,类似于字典中的一个条目。键是变量的名称,值是变量的实际值。Postman使用双花括号语法来表示变量。在运行时(在向服务器发送请求之前),Postman会用实际值替换变量。

变量的语法如下: {{variable}}

什么是Postman环境?
Postman环境代表了API或服务的主机/运行时环境,如开发环境、测试环境等。它包含一个或多个具有隔离作用域的Postman变量。可以在任何请求部分(如URL、头部和正文)中使用这些变量,以创建环境通用的请求模板。

示例场景:
假设有一个用于产品管理的API,它为产品管理提供了各种API功能。将使用产品详细信息API功能作为演示。
产品详细信息API:
动词:GET
URL:https://www.products.com/api/v1/products/<product id>
头部:
x-api-key: <api key>
例如:https://www.products.com/api/v1/products/2

由于上述API实际上并不存在,将使用httpbin.org来演示Postman环境的工作方式。Httpbin.org提供了一组HTTP回声API,它将在HTTP响应中返回请求的详细信息,因此它是理解Postman环境的正确选择。

要使用Postman环境,需要执行以下主要步骤:

  1. 从API/服务请求中识别特定于环境的元素。
  2. 创建特定于API主机/运行时环境的Postman环境。
  3. 在环境中为在步骤1中识别的每个特定于环境的元素创建变量。
  4. 使用新创建的环境创建环境通用请求模板
  5. 在多个环境中运行请求。

根据上述的产品API示例,可以推断出域名和API密钥将根据环境而变化,因此可以在环境中创建hostapi_key变量。

如何创建Postman环境?
按照以下步骤创建环境:

  1. 打开Postman桌面应用程序。一旦打开,可以在Postman窗口的右上角找到一个小设置图标。点击设置图标。
  2. 管理环境弹出窗口将打开,当第一次打开时,它将显示一个空列表。
  3. 点击帮助文本中的“创建环境”链接或弹出窗口底部的“添加”按钮。
  4. 添加环境表单将打开。首先,需要输入环境名称,然后输入所需的变量名称和值。
  5. 根据示例,按照以下步骤创建环境:
    1. 在环境名称字段中输入“Development”。
    2. 在第一行新键字段中输入host,在值字段中输入dev.products.com
    3. 在第二行新键字段中输入api_key,在值字段中输入xxxxxxxxxx-dev-xxxxxxxxxx
    4. 点击“添加”按钮。
  6. 它将返回到管理环境弹出窗口。现在,它将在列表中列出新创建的开发环境。

为了更好地理解Postman环境功能,需要至少创建一个更多的环境。这次不需要从头开始创建环境。可以使用“复制环境”选项。

  1. 点击开发环境行的“复制环境”图标。
  2. 点击“Development Copy”环境。
  3. 将环境名称更改为“QA”。
  4. host值更改为qa.products.com
  5. api_key值更改为xxxxxxxxxx-qa-xxxxxxxxxx
  6. 点击“更新”按钮。

它将返回到管理环境弹出窗口。现在可以看到开发和测试环境。 一旦创建了所需的环境,关闭管理环境窗口。

如何创建Postman环境通用请求模板
现在,准备使用新创建的Postman环境创建环境通用模板。按照以下步骤创建请求模板:

  1. 从环境下拉菜单中选择“Development”。
  2. 在URL字段中输入https://httpbin.org/get/?url=https://{{host}}/api/v1/products/2。可以注意到,一旦输入双花括号,Postman就会显示变量智能感知,可以从这里选择所需的变量。
  3. 转到“头部”标签。在键字段中输入x-api-key,在值字段中输入{{api_key}}
  4. 现在准备好测试请求了,在此之前,需要打开Postman控制台以查看请求日志。
  5. 点击“视图”->“显示Postman控制台”或按Alt + Ctrl + C。它将带来Postman控制台并将其放在一边。
  6. 点击发送按钮将请求发送到httpbin.org API。
  7. 转到Postman控制台以查看请求日志。如果可以看到Postman用实际值替换了URL和头部部分的所有变量。
  8. 返回Postman主窗口以查看httpbin.org响应。它也确认了在控制台窗口中看到的结果。

可以通过更改环境下拉菜单来重用相同的请求,以适应不同的环境。 要切换到另一个环境,需要更改环境下拉菜单。将环境更改为“QA”,现在可以在不同的环境运行相同的请求。

沪ICP备2024098111号-1
上海秋旦网络科技中心:上海市奉贤区金大公路8218号1幢 联系电话:17898875485