环境是您可以在 Postman 请求中使用的一组变量。如果您是团队的一员,您可以使用环境将相关的值组合在一起,并管理对共享
Postman 数据的访问。
创建环境
您将在 Postman 的右上角看到选定的环境状态,在下拉菜单中选择了任何活动环境。在左侧的环境中,您可以访问所有环境,然后选择复选标记按钮以激活环境。选择一个环境以将其打开以在选项卡中进行编辑。
在下拉列表的右侧,您还将看到环境快速查看(眼睛)按钮。快速查看列出了活动环境的变量,以及您已声明(或通过您的工作区共享)的任何全局变量。
要创建新环境,请选择左侧的环境,然后选择+加号按钮。
为您的环境输入一个名称,并使用您需要的任何变量对其进行初始化——您也可以稍后为环境指定变量。
选择保存以保存您添加的任何环境变量。
添加环境变量
您可以通过从 Postman 左侧打开环境并在打开的选项卡中进行编辑,将变量添加到活动(当前选择的)环境中。
在线编辑变量名称和值,或使用 X 按钮删除变量。在新行上输入新变量的名称和值。完成更改后保存。
或者,打开环境快速查看(右上角的眼睛按钮)并进行内联编辑。
如果您作为团队的一部分使用环境变量,则只有在对环境具有编辑权限的情况下才能更改初始值。您可以访问与您共享的环境中的所有变量,但如果您具有查看者角色,则可能对初始值具有只读访问权限。
输入变量的名称,并指定其初始值和当前值。默认情况下,当前值将复制初始值。
- 初始值通过 Postman 服务器同步到您的帐户,并与任何有权访问该环境的协作者共享。
- 当前值在您的 Postman 应用程序中是本地的,并且永远不会同步到您的帐户或与您的团队共享
-除非您选择持久保存它。
三个点图标要使用您的本地值更新同步变量,请通过选择变量行的右侧并选择Persist将初始值设置为当前值。要使用与您的工作区/协作者共享的同步值重置您的本地(当前)值,请选择重置。您可以使用Persist
All和Reset All保留或重置环境中的所有值。
您还可以按Type定义环境变量。变量在创建时自动分配默认类型,显示为纯文本,没有附加属性。您可以将敏感变量更改为secret
type,这会掩盖所有工作区成员的初始值和当前值。机密类型可用于防止无意泄露敏感数据,包括
API 机密、密码、令牌和密钥。
访问环境
您可以从 Postman UI 和请求元素(包括 URL、参数、正文数据和测试脚本)访问环境变量。
要查看所有环境,请选择Postman 左侧的环境。
您可以在此处添加、共享、复制、下载、管理访问、删除和从工作区移除共享环境。您还可以通过选择Globals访问您的全局变量。
要查看环境中的变量,请选择其名称。您可以在此处编辑、添加和删除环境中的变量。
选择活跃的环境
要在环境中使用变量,请从 Postman 右上角的下拉列表中选择它。
要一目了然地检查变量值,请使用快速查看(眼睛按钮)。
当您在下拉列表中选择了一个环境时,Postman 会将其视为活动环境,并将针对该环境运行所有请求(如果您的请求引用环境变量)。
要在请求中使用环境变量值,请按名称引用它,并用双花括号括起来:
您可以在请求 URL、参数、标头和正文数据中使用相同的变量表示法。
将鼠标悬停在变量引用上以查看其当前值。
如果一个请求可以使用多个同名变量,Postman 将使用范围最窄的变量中的值。这意味着如果您有一个与集合或全局变量同名的环境变量,Postman
将使用该环境变量,但本地和数据变量值将取代环境值。任何被覆盖的变量的值都将以删除线显示。
您可以在预请求和测试代码中访问当前环境变量值。
pm.environment.get("variable_key");
|
您可以使用API 文档和在 Postman 中运行按钮发布环境。
编辑环境变量
您可以通过从左侧的Environments打开环境,或打开 Postman 右上角的环境快速查看(眼睛按钮)并选择Edit来编辑变量。
您将只能编辑您拥有编辑权限的环境。
编辑环境名称或变量的名称、类型和值,记住初始值将与您的 Postman 帐户同步,并与任何有权访问该环境的协作者共享。编辑完成后选择保存。
如果您对环境具有查看器访问权限,您会在名称旁边看到一个挂锁图标,表明它是只读的,并且您只能编辑当前值,该值仅对您可见,不会与您的同步邮递员帐户或工作区。要编辑初始值,您需要Request
Access。
您可以通过环境快速查看直接在活动(当前选定)环境中编辑变量的当前值。选择铅笔图标以编辑您选择的值。
您还可以从测试脚本更新环境变量值。
从脚本设置环境变量
您的预请求和测试脚本可以更新环境变量值。
使用pm.environment在活动(当前选择的)环境中设置环境变量:
pm.environment.set("variable_key", "variable_value");
|
您只能在具有编辑权限的环境中从脚本创建新变量。如果您在具有环境查看者访问权限的脚本中更新或取消设置值,则该更改将仅对您可见,而不会与您的团队共享。
如果您使用脚本设置环境变量值,这些将反映在所有引用变量的请求中。例如,您可以将环境与收集运行器和监视器结合使用,以便在一系列请求的整个运行过程中以及完成后共享更新的值。
作为一个团队使用环境
您可以使用环境在共享资源上进行协作并配置敏感数据的可见性,包括 API 机密、密码、令牌和密钥。
在共享工作区中,您创建和更新的任何全局变量都将可供工作区中的其他人使用。您可以将变量定义为机密类型,以屏蔽所有工作区成员的初始值和当前值,并防止无意泄露敏感数据。您还可以使用全局变量的当前值来限制协作者的某些值,但默认情况下,全局变量的初始值通常可以在整个工作区中访问。
您可以将环境移动到共享工作区以与您的团队协作。
您必须是环境的编辑者或工作区管理员,才能将环境移动到另一个工作区。
在左侧边栏中导航到您要共享的环境,选择它,然后选择三个点图标>移动。
使用搜索栏查找要将环境移动到的工作区,或通过选择搜索栏右侧的图标按工作区可见性进行过滤。
您可以将环境共享到您有权访问的个人、私人、团队和公共工作区。共享的私人、团队和公共工作区允许您与他人协作。
您不能将环境从团队、私人或公共工作区移动到个人工作区。
有关团队内工作区访问控制的信息,请参阅角色和权限。
选择工作区,然后选择移动 环境。
请注意,使用环境的原始工作空间中的监视器、模拟服务器和集成可能不再工作,需要在新工作空间中重新配置。使用该环境的集合和
API 必须单独移动。
您可以通过在左侧边栏中导航到环境中的角色,选择它,然后选择三个点图标> Manage
Roles来管理环境中的角色。
您还可以从工作空间中删除共享环境,方法是选择三个点图标环境名称旁边的并选择移动以将其移动到不同的工作空间,或选择删除以将其完全删除。
要导出环境,请选择它并三个点图标在右上角选择 >导出。
管理环境角色
您可以通过选择三个点图标右上角的 >管理角色来管理环境中的角色。
您可以为协作者分配编辑者或查看者角色。具有查看者角色的用户只能编辑变量的当前值,但他们可以在发送请求时使用环境。如果用户需要编辑权限,他们可以在编辑器中查看环境时提出请求。
有关更多详细信息,请参阅环境角色。
在查看者角色中使用环境
如果您具有对环境的查看权限,您将能够访问变量的值以在您的请求中使用它们,但将无法更新与您的团队共享的Initial
Value。您可以更新Current Value,但这不会与您团队中的任何人共享或与您的 Postman
帐户同步。
如果您使用 API 凭据等敏感数据,则使用环境变量的当前值来处理这些数据会更安全。如果没有对环境的编辑访问权限,您将无法保持当前值以更新环境变量的初始值。您可以随时使用“重置”选项将本地当前值更新为共享初始值。
请求环境访问
如果您需要在具有只读权限的环境中更新变量的初始值,您可以请求编辑权限。从Postman 左侧的Environments打开环境,然后选择Request
Access。
选择您要向其提交请求的团队成员,然后从下拉列表中选择Editor 。选择请求访问。当您的请求获得批准时,您将收到一封电子邮件。
在编辑角色中使用环境
如果您对环境具有编辑权限,则可以从 Postman UI 和脚本更新变量值。如果您使用 API
机密、密码、令牌或密钥等敏感数据,您可以将变量定义为机密类型以屏蔽其初始值和当前值。您还可以选择仅使用当前值,这些值不会与您的团队同步或共享。
当您编辑共享环境变量的初始值时,您更新的值将反映给有权访问该环境的每个人,因此请确保仅在您对您的值与
Postman 服务器同步感到满意时才执行此操作。
如果您在您的环境中取消选中(取消选择)某个变量,则该变量将仅可供对环境具有编辑权限的协作者使用。他们还将能够查看变量是否处于活动状态。具有环境查看者角色的任何人都不会看到未选中的变量。
使用编辑角色,您可以为其他团队成员配置访问权限。如果您需要指定访问权限但没有编辑者角色,您可以请求访问权限。
下一步
共享环境允许您利用 Postman 中的协作。查看更多关于如何在 API 开发项目中与团队成员合作的资源:
- 在 Postman 中协作
- 工作区简介
- 管理和共享 API
- 集合的版本控制
|