跳到主要内容

管理环境(environments)

环境是一组可以在 Postman 请求中使用的 变量。 如果你作为团队的一部分工作,则可以使用环境将相关的值集组合在一起并管理对共享 Postman 数据的访问。

创建环境

Postman 在位于工作台右上角的环境选择器中显示活动环境。

你可以从侧边栏中的环境访问所有环境。选择环境旁边的设置活动图标, 设置活动图标 使其成为活动环境。

选择环境名称以打开环境编辑器。

环境编辑器

环境快速查看图标 环境快速查看图标 位于环境选择器旁边。环境快速查看列出了活动环境的变量,以及你已声明或在你的工作空间中共享的任何全局变量。

选择环境快速查看

要创建新环境,请执行以下操作:

  1. 选择左侧的环境并选择**+**

    创造新环境

  2. 为你的环境输入一个名称,并使用你需要的任何变量对其进行初始化。你也可以稍后为环境指定变量。

  3. 选择保存以保存你添加的任何环境变量。

添加环境变量

你可以通过从侧边栏打开环境并在打开的选项卡中编辑它来将变量添加到活动(当前选择的)环境。

添加环境

内联编辑变量名称和值,或使用关闭图标 关闭图标 删除变量。在新行中输入新变量的名称和值。更改完成后保存。

或者,选择环境快速查看图标 环境快速查看图标 并内联编辑。

如果你作为团队的一部分使用环境变量,则只有在你对环境 具有编辑权限时才能更改初始值。你可以访问与你共享的环境中的所有变量,但如果你具有查看者角色,则可能对初始值具有只读访问权限。

输入变量的名称,并指定其初始值当前值。默认情况下,当前值将复制初始值。

  • 初始使用 Postman 服务器同步到你的帐户。它与有权访问环境的任何协作者共享。
  • 当前值用于你本地的 Postman 实例,并且永远不会同步到你的帐户或与你的团队共享,除非你选择保留它

更多操作图标 要使用你的本地值更新同步变量,请通过选择更多操作图标并选择Persist将初始值设置为当前值 。要使用与你的工作空间/协作者共享的同步值重置你的本地(当前)值,请选择重置你可以使用 Persist AllReset All保留或重置环境中的所有值。

你还可以通过Type定义环境变量。变量在创建时自动分配默认类型,显示为纯文本并且没有额外的属性。你可以将敏感变量更改为 secret 类型 ,这会屏蔽所有工作空间成员的初始值和当前值。Secret 类型可用于防止无意中泄露敏感数据,包括 API 机密、密码、令牌和密钥。

访问环境

你可以从 Postman 和你的请求元素访问你的环境变量,包括 URL、参数、正文数据和测试脚本。

对于所有环境的列表,请在边栏中选择环境。

查看所有环境

你可以在此处添加、共享、复制、下载、管理访问、删除和从工作空间中移除共享环境。你还可以通过选择Globals来访问你的全局变量。

要查看环境中的变量,请选择其名称。你可以在此处编辑、添加和删除环境中的变量。你还可以使用Filter variables控件来搜索环境中的变量。

编辑环境

选择活动环境

要在环境中使用变量,请从工作台右上角的环境选择器中选择它。

环境选择器

要一目了然地检查变量值,请使用环境快速查看图标 环境快速查看图标

当你使用环境选择器选择一个环境时,Postman 会将其视为活动环境并使用来自该环境的值运行所有请求(如果你的请求引用环境变量)。

要在请求中使用环境变量值,请按名称引用它,用 双花括号 括起来:

你可以在请求 URL、参数、header 和正文数据中使用相同的变量表示法。

环境变量参考

将鼠标悬停在变量引用上以获取其当前值。

如果一个请求有多个同名变量,Postman 将使用 范围 最窄的变量的值。这意味着如果你有一个与集合或全局变量同名的环境变量,Postman 将使用该环境变量,但本地和数据变量值将取代环境值。任何被覆盖的变量的值将以删除线显示。

你可以在预请求测试代码中访问当前环境变量值。

pm.environment.get("variable_key");

你可以使用 API 文档Run in Postman 按钮 发布环境。

编辑环境变量

你可以通过从左侧的 Environments 打开环境,或通过 在工作台中选择环境选择器 环境快速查看图标 旁边的环境快速查看图标并选择Edit来编辑变量。你可以通过选择任何列标题在字母升序或降序和自定义顺序之间切换来对变量列表进行排序。要按自定义顺序对列表进行排序,请清除活动排序,然后使用左侧的手柄拖动行以重新排序。

你将只能编辑你拥有 编辑访问权限的 环境。

编辑环境

编辑环境名称或变量的名称、 类型 和值,请记住初始值将与你的 Postman 帐户同步并与有权访问该环境的任何协作者共享。编辑完成后选择保存。

环境中的查看者角色

如果你对某个环境具有查看者访问权限,则名称旁边的锁定图标 锁定图标 表示它是只读的。你将只能编辑当前值,该值仅对你可见,不会与你的 Postman 帐户或工作空间同步。要编辑初始值,你需要Request Access

你可以使用环境快速查看直接编辑活动(当前选定)环境中变量的当前值。选择编辑图标 编辑图标 以编辑你选择的值。

使用环境快速查看

你还可以从测试脚本更新环境变量值。

从脚本设置环境变量

你的预请求测试脚本可以更新环境变量值。

使用 pm.environment 在活动(当前选择的)环境中设置环境变量:

pm.environment.set("variable_key", "variable_value");

你只能在你具有编辑权限的环境中从脚本创建新变量。如果你更新或取消设置具有环境查看者访问权限的脚本中的值,则该更改将仅对你可见,而不会与你的团队共享。

如果你使用脚本来设置环境变量值,这些将反映在所有引用变量的请求中。例如,你可以将环境与 collection run 器和 监视器 结合 使用,以在一系列请求的整个运行过程中以及完成后共享更新的值。

作为一个团队与环境一起工作

你可以使用环境在共享资源上进行协作并配置敏感数据的可见性,包括 API 机密、密码、令牌和密钥。

在共享工作空间中,你创建和更新的任何全局变量都将可供工作空间中的其他人使用。你可以将变量定义为 机密类型 ,以屏蔽所有工作空间成员的初始值和当前值,并防止无意中泄露敏感数据。你还可以使用全局变量的当前值来限制协作者的某些值,但默认情况下,全局变量的初始值通常可以在整个工作空间中访问。

你可以将环境移动到共享工作空间以与你的团队协作。

你必须是环境的编辑者或工作空间管理员才能将环境移动到另一个工作空间。要了解有关角色和权限的更多信息,请参阅 定义角色

在边栏中,选择要共享的环境,然后选择更多操作图标 更多操作图标 >移动

使用搜索栏查找你要将环境移动到的工作空间,或通过选择过滤器图标 来按工作空间可见性进行过滤 过滤器图标

你可以将环境共享到你有权访问的个人、私人、团队和公共工作空间。共享的私人、团队和公共工作空间让你可以与他人协作。

你不能将环境从团队、私人或公共工作空间移动到个人工作空间。

有关团队内工作空间访问控制的信息,请参阅 角色和权限。

选择工作空间,然后选择Move Environment

移动环境

请注意,原始工作空间中使用该环境的监视器、模拟服务器和集成可能不再有效,需要在新工作空间中重新配置。使用该环境的集合和 API 必须 单独移动

你可以通过在边栏中导航到环境并选择它,然后选择更多操作图标 更多操作图标 >管理角色来管理环境中的角色。

管理角色环境

更多操作图标 你还可以通过选择环境名称旁边的更多操作图标 并选择移动将其移动到不同的工作空间或选择删除将其完全删除,从而从工作空间中删除共享环境。

要导出环境,请选择它并选择 更多操作图标 右上角的更多操作图标 >导出

导出环境

管理环境角色

更多操作图标 你可以通过选择右上角的更多操作图标 >管理角色来管理环境中的角色 。

你可以为协作者分配编辑者或查看者角色。具有查看者角色的团队成员只能编辑变量的当前值,但他们可以在发送请求时使用环境。如果用户需要编辑权限,他们可以在编辑器中查看环境时提出请求。

有关详细信息,请参阅 环境角色

在 Viewer 角色中使用环境

如果你拥有环境的查看者角色,你将能够访问变量的值以在你的请求中使用它们,但无法更新与你的团队共享的初始值。你可以更新Current Value,但这不会与你团队中的任何人共享,也不会与你的 Postman 帐户同步。

如果你使用 API 凭据等敏感数据,则为这些数据使用环境变量的当前值会更安全。如果没有对环境的编辑权限,你将无法保留当前值来更新环境变量的初始值。你可以随时使用重置选项使用共享初始值更新本地当前值。

请求环境访问

如果你需要在你具有只读访问权限的环境中更新变量的初始值,你可以请求编辑访问权限。从侧边栏中的Environments打开环境,然后选择Request Access

环境中的查看者角色

选择你要向其提交请求的团队成员,然后选择编辑者角色。选择请求访问权。当你的请求获得批准后,你将收到一封电子邮件。

在 Editor 角色中使用环境

如果你对环境具有编辑权限,则可以从 Postman 和脚本更新变量值。如果你使用 API 机密、密码、令牌或密钥等敏感数据,则可以将变量定义为 机密类型 以屏蔽其初始值和当前值。你还可以选择仅使用当前值,这些值不会与你的团队同步或共享。

当你编辑共享环境变量的初始值时,更新后的值将反映给有权访问该环境的每个人,因此请确保仅在你对与 Postman 服务器同步你的值感到满意时才执行此操作。

如果你清除环境中某个变量的复选框,则它仅对对环境也具有编辑访问权限的协作者可用。变量的列表还将指示它是否处于活动状态。具有环境查看者角色的任何人都无法访问已清除的变量。

使用编辑者角色,你可以 为其他团队成员配置访问权限 。如果你需要指定访问权限但没有 Editor 角色,则可以 请求访问权限

Forking 环境

你可以 Forking 环境以在不影响其基础版本的情况下更改它们,或者在没有编辑访问权限的情况下为它们的开发做出贡献。

  1. 将鼠标悬停在边栏中的环境上,然后选择更多操作图标 更多操作图标
  2. 选择创建 Forking

你还可以通过在环境概览选项卡中选择Forking 来 Forking 环境。Forking图标

你可以编辑你的环境分支并根据需要使用它,或者你可以 创建拉取请求 来更新原始环境。

查看拉取请求、Forking 和环境详细信息

你可以从右侧边栏查看所有拉取请求、分支和有关环境的详细信息。

如果你对环境具有 编辑访问权限,则可以 查看拉取请求 并将 更改合并到父环境中

下一步

共享环境允许你在 Postman 中利用协作。查看更多有关如何与团队成员合作处理 API 开发项目的资源: