Postman 管理環(huán)境

2023-04-03 11:10 更新

環(huán)境是一組可以在 Postman 請(qǐng)求中使用的變量。如果您作為團(tuán)隊(duì)的一部分工作,則可以使用環(huán)境將相關(guān)的值集組合在一起并管理對(duì)共享 Postman 數(shù)據(jù)的訪問。

創(chuàng)建環(huán)境

Postman 在位于工作臺(tái)右上角的環(huán)境選擇器中顯示活動(dòng)環(huán)境。

您可以從側(cè)邊欄中的環(huán)境訪問所有環(huán)境。選擇環(huán)境旁邊的設(shè)置活動(dòng)圖標(biāo), 設(shè)置活動(dòng)圖標(biāo) 使其成為活動(dòng)環(huán)境。

選擇環(huán)境名稱以打開環(huán)境編輯器。

環(huán)境編輯器

環(huán)境快速查看圖標(biāo) 環(huán)境快速查看圖標(biāo) 位于環(huán)境選擇器旁邊。環(huán)境快速查看列出了活動(dòng)環(huán)境的變量,以及您已聲明或在您的工作區(qū)中共享的任何全局變量。

選擇環(huán)境快速查看

要?jiǎng)?chuàng)建新環(huán)境,請(qǐng)執(zhí)行以下操作:

  1. 選擇左側(cè)的環(huán)境并選擇+。創(chuàng)造新環(huán)境
  2. 為您的環(huán)境輸入一個(gè)名稱,并使用您需要的任何變量對(duì)其進(jìn)行初始化。您也可以稍后為環(huán)境指定變量。
  3. 選擇保存以保存您添加的任何環(huán)境變量。

添加環(huán)境變量

您可以通過從側(cè)邊欄打開環(huán)境并在打開的選項(xiàng)卡中編輯它來(lái)將變量添加到活動(dòng)(當(dāng)前選擇的)環(huán)境。

添加環(huán)境

內(nèi)聯(lián)編輯變量名稱和值,或使用關(guān)閉圖標(biāo) 關(guān)閉圖標(biāo) 刪除變量。在新行中輸入新變量的名稱和值。更改完成后保存。

或者,選擇環(huán)境快速查看圖標(biāo) 環(huán)境快速查看圖標(biāo) 并內(nèi)聯(lián)編輯。

如果您作為團(tuán)隊(duì)的一部分使用環(huán)境變量,則只有在您對(duì)環(huán)境具有編輯權(quán)限時(shí)才能更改初始值。您可以訪問與您共享的環(huán)境中的所有變量,但如果您具有查看者角色,則可能對(duì)初始值具有只讀訪問權(quán)限。

輸入變量的名稱,并指定其初始值和當(dāng)前值。默認(rèn)情況下,當(dāng)前值將復(fù)制初始值。

  • 初始值使用 Postman 服務(wù)器同步到您的帳戶。它與有權(quán)訪問環(huán)境的任何協(xié)作者共享。
  • 當(dāng)前值用于您本地的 Postman 實(shí)例,并且永遠(yuǎn)不會(huì)同步到您的帳戶或與您的團(tuán)隊(duì)共享,除非您選擇保留它。

更多操作圖標(biāo) 要使用您的本地值更新同步變量,請(qǐng)通過選擇更多操作圖標(biāo)并選擇Persist將初始值設(shè)置為當(dāng)前值 。要使用與您的工作區(qū)/協(xié)作者共享的同步值重置您的本地(當(dāng)前)值,請(qǐng)選擇重置。您可以使用Persist All和Reset All保留或重置環(huán)境中的所有值。

您還可以通過Type定義環(huán)境變量。變量在創(chuàng)建時(shí)自動(dòng)分配默認(rèn)類型,顯示為純文本并且沒有額外的屬性。您可以將敏感變量更改為secret 類型,這會(huì)屏蔽所有工作區(qū)成員的初始值和當(dāng)前值。Secret 類型可用于防止無(wú)意中泄露敏感數(shù)據(jù),包括 API 機(jī)密、密碼、令牌和密鑰。

訪問環(huán)境

您可以從 Postman 和您的請(qǐng)求元素訪問您的環(huán)境變量,包括 URL、參數(shù)、正文數(shù)據(jù)和測(cè)試腳本。

對(duì)于所有環(huán)境的列表,請(qǐng)?jiān)谶厵谥羞x擇環(huán)境。

查看所有環(huán)境

您可以在此處添加、共享、復(fù)制、下載、管理訪問、刪除和從工作區(qū)中移除共享環(huán)境。您還可以通過選擇Globals來(lái)訪問您的全局變量。

要查看環(huán)境中的變量,請(qǐng)選擇其名稱。您可以在此處編輯、添加和刪除環(huán)境中的變量。您還可以使用Filter variables控件來(lái)搜索環(huán)境中的變量。

編輯環(huán)境

選擇活動(dòng)環(huán)境

要在環(huán)境中使用變量,請(qǐng)從工作臺(tái)右上角的環(huán)境選擇器中選擇它。

環(huán)境選擇器

要一目了然地檢查變量值,請(qǐng)使用環(huán)境快速查看圖標(biāo) 環(huán)境快速查看圖標(biāo) 。

當(dāng)您使用環(huán)境選擇器選擇一個(gè)環(huán)境時(shí),Postman 會(huì)將其視為活動(dòng)環(huán)境并使用來(lái)自該環(huán)境的值運(yùn)行所有請(qǐng)求(如果您的請(qǐng)求引用環(huán)境變量)。

要在請(qǐng)求中使用環(huán)境變量值,請(qǐng)按名稱引用它,用雙花括號(hào)括起來(lái):

{{base_url}}

您可以在請(qǐng)求 URL、參數(shù)、標(biāo)頭和正文數(shù)據(jù)中使用相同的變量表示法。

環(huán)境變量參考

將鼠標(biāo)懸停在變量引用上以獲取其當(dāng)前值。

如果一個(gè)請(qǐng)求有多個(gè)同名變量,Postman 將使用范圍最窄的變量的值。這意味著如果您有一個(gè)與集合或全局變量同名的環(huán)境變量,Postman 將使用該環(huán)境變量,但本地和數(shù)據(jù)變量值將取代環(huán)境值。任何被覆蓋的變量的值將以刪除線顯示。

您可以在預(yù)請(qǐng)求和測(cè)試代碼中訪問當(dāng)前環(huán)境變量值。

pm.environment.get("variable_key");
您可以使用API 文檔和Run in Postman 按鈕發(fā)布環(huán)境。

編輯環(huán)境變量

您可以通過從左側(cè)的 Environments打開環(huán)境,或通過在工作臺(tái)中選擇環(huán)境選擇器環(huán)境快速查看圖標(biāo) 旁邊的環(huán)境快速查看圖標(biāo)并選擇Edit來(lái)編輯變量。您可以通過選擇任何列標(biāo)題在字母升序或降序和自定義順序之間切換來(lái)對(duì)變量列表進(jìn)行排序。要按自定義順序?qū)α斜磉M(jìn)行排序,請(qǐng)清除活動(dòng)排序,然后使用左側(cè)的手柄拖動(dòng)行以重新排序。

您將只能編輯您擁有編輯訪問權(quán)限的環(huán)境。

編輯環(huán)境

編輯環(huán)境名稱或變量的名稱、類型和值,請(qǐng)記住初始值將與您的 Postman 帳戶同步并與有權(quán)訪問該環(huán)境的任何協(xié)作者共享。編輯完成后選擇保存。

環(huán)境中的查看者角色

如果您對(duì)某個(gè)環(huán)境具有查看者訪問權(quán)限,則名稱旁邊的鎖定圖標(biāo) 鎖定圖標(biāo) 表示它是只讀的。您將只能編輯當(dāng)前值,該值僅對(duì)您可見,不會(huì)與您的 Postman 帳戶或工作區(qū)同步。要編輯初始值,您需要Request Access。

您可以使用環(huán)境快速查看直接編輯活動(dòng)(當(dāng)前選定)環(huán)境中變量的當(dāng)前值。選擇編輯圖標(biāo)  以編輯您選擇的值。

使用環(huán)境快速查看

您還可以從測(cè)試腳本更新環(huán)境變量值。

從腳本設(shè)置環(huán)境變量

您的預(yù)請(qǐng)求和測(cè)試腳本可以更新環(huán)境變量值。

使用pm.environment在活動(dòng)(當(dāng)前選擇的)環(huán)境中設(shè)置環(huán)境變量:

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

您只能在您具有編輯權(quán)限的環(huán)境中從腳本創(chuàng)建新變量。如果您更新或取消設(shè)置具有環(huán)境查看者訪問權(quán)限的腳本中的值,則該更改將僅對(duì)您可見,而不會(huì)與您的團(tuán)隊(duì)共享。

如果您使用腳本來(lái)設(shè)置環(huán)境變量值,這些將反映在所有引用變量的請(qǐng)求中。例如,您可以將環(huán)境與收集運(yùn)行器和監(jiān)視器結(jié)合使用,以在一系列請(qǐng)求的整個(gè)運(yùn)行過程中以及完成后共享更新的值。

作為一個(gè)團(tuán)隊(duì)與環(huán)境一起工作

您可以使用環(huán)境在共享資源上進(jìn)行協(xié)作并配置敏感數(shù)據(jù)的可見性,包括 API 機(jī)密、密碼、令牌和密鑰。

在共享工作區(qū)中,您創(chuàng)建和更新的任何全局變量都將可供工作區(qū)中的其他人使用。您可以將變量定義為機(jī)密類型,以屏蔽所有工作區(qū)成員的初始值和當(dāng)前值,并防止無(wú)意中泄露敏感數(shù)據(jù)。您還可以使用全局變量的當(dāng)前值來(lái)限制協(xié)作者的某些值,但默認(rèn)情況下,全局變量的初始值通??梢栽谡麄€(gè)工作區(qū)中訪問。

您可以將環(huán)境移動(dòng)到共享工作區(qū)以與您的團(tuán)隊(duì)協(xié)作。

您必須是環(huán)境的編輯者或工作區(qū)管理員才能將環(huán)境移動(dòng)到另一個(gè)工作區(qū)。要了解有關(guān)角色和權(quán)限的更多信息,請(qǐng)參閱定義角色。

在邊欄中,選擇要共享的環(huán)境,然后選擇更多操作圖標(biāo) 更多操作圖標(biāo) >移動(dòng)。

使用搜索欄查找您要將環(huán)境移動(dòng)到的工作空間,或通過選擇過濾器圖標(biāo) 來(lái)按工作空間可見性進(jìn)行過濾 過濾器圖標(biāo) 。

您可以將環(huán)境共享到您有權(quán)訪問的個(gè)人、私人、團(tuán)隊(duì)和公共工作區(qū)。共享的私人、團(tuán)隊(duì)和公共工作空間讓您可以與他人協(xié)作。

您不能將環(huán)境從團(tuán)隊(duì)、私人或公共工作區(qū)移動(dòng)到個(gè)人工作區(qū)。
有關(guān)團(tuán)隊(duì)內(nèi)工作區(qū)訪問控制的信息,請(qǐng)參閱角色和權(quán)限。

選擇工作區(qū),然后選擇Move Environment。

移動(dòng)環(huán)境

請(qǐng)注意,原始工作區(qū)中使用該環(huán)境的監(jiān)視器、模擬服務(wù)器和集成可能不再有效,需要在新工作區(qū)中重新配置。使用該環(huán)境的集合和 API 必須單獨(dú)移動(dòng)

您可以通過在邊欄中導(dǎo)航到環(huán)境并選擇它,然后選擇更多操作圖標(biāo) 更多操作圖標(biāo) >管理角色來(lái)管理環(huán)境中的角色。

管理角色環(huán)境

更多操作圖標(biāo) 您還可以通過選擇環(huán)境名稱旁邊的更多操作圖標(biāo) 并選擇移動(dòng)將其移動(dòng)到不同的工作區(qū)或選擇刪除將其完全刪除,從而從工作區(qū)中刪除共享環(huán)境。

要導(dǎo)出環(huán)境,請(qǐng)選擇它并選擇 更多操作圖標(biāo) 右上角的更多操作圖標(biāo) >導(dǎo)出。

導(dǎo)出環(huán)境

管理環(huán)境角色

更多操作圖標(biāo) 您可以通過選擇右上角的更多操作圖標(biāo) >管理角色來(lái)管理環(huán)境中的角色 。

您可以為協(xié)作者分配編輯者或查看者角色。具有查看者角色的團(tuán)隊(duì)成員只能編輯變量的當(dāng)前值,但他們可以在發(fā)送請(qǐng)求時(shí)使用環(huán)境。如果用戶需要編輯權(quán)限,他們可以在編輯器中查看環(huán)境時(shí)提出請(qǐng)求。

有關(guān)詳細(xì)信息,請(qǐng)參閱環(huán)境角色。

在 Viewer 角色中使用環(huán)境

如果您擁有環(huán)境的查看者角色,您將能夠訪問變量的值以在您的請(qǐng)求中使用它們,但無(wú)法更新與您的團(tuán)隊(duì)共享的初始值。您可以更新Current Value,但這不會(huì)與您團(tuán)隊(duì)中的任何人共享,也不會(huì)與您的 Postman 帳戶同步。

如果您使用 API 憑據(jù)等敏感數(shù)據(jù),則為這些數(shù)據(jù)使用環(huán)境變量的當(dāng)前值會(huì)更安全。如果沒有對(duì)環(huán)境的編輯權(quán)限,您將無(wú)法保留當(dāng)前值來(lái)更新環(huán)境變量的初始值。您可以隨時(shí)使用重置選項(xiàng)使用共享初始值更新本地當(dāng)前值。

請(qǐng)求環(huán)境訪問

如果您需要在您具有只讀訪問權(quán)限的環(huán)境中更新變量的初始值,您可以請(qǐng)求編輯訪問權(quán)限。從側(cè)邊欄中的Environments打開環(huán)境,然后選擇Request Access。

環(huán)境中的查看者角色

選擇您要向其提交請(qǐng)求的團(tuán)隊(duì)成員,然后選擇編輯者角色。選擇請(qǐng)求訪問權(quán)。當(dāng)您的請(qǐng)求獲得批準(zhǔn)后,您將收到一封電子郵件。

在 Editor 角色中使用環(huán)境

如果您對(duì)環(huán)境具有編輯權(quán)限,則可以從 Postman 和腳本更新變量值。如果您使用 API 機(jī)密、密碼、令牌或密鑰等敏感數(shù)據(jù),則可以將變量定義為機(jī)密類型以屏蔽其初始值和當(dāng)前值。您還可以選擇僅使用當(dāng)前值,這些值不會(huì)與您的團(tuán)隊(duì)同步或共享。

當(dāng)您編輯共享環(huán)境變量的初始值時(shí),更新后的值將反映給有權(quán)訪問該環(huán)境的每個(gè)人,因此請(qǐng)確保僅在您對(duì)與 Postman 服務(wù)器同步您的值感到滿意時(shí)才這樣做。

如果您清除環(huán)境中某個(gè)變量的復(fù)選框,則該變量將僅對(duì)對(duì)環(huán)境也具有編輯訪問權(quán)限的協(xié)作者可用。變量的列表還將指示它是否處于活動(dòng)狀態(tài)。具有環(huán)境查看者角色的任何人都無(wú)法訪問已清除的變量。

使用編輯者角色,您可以為其他團(tuán)隊(duì)成員配置訪問權(quán)限。如果您需要指定訪問權(quán)限但沒有 Editor 角色,則可以請(qǐng)求訪問權(quán)限。

分叉環(huán)境

您可以分叉環(huán)境以在不影響其基礎(chǔ)版本的情況下更改它們,或者在沒有編輯訪問權(quán)限的情況下為它們的開發(fā)做出貢獻(xiàn)。

  1. 將鼠標(biāo)懸停在邊欄中的環(huán)境上,然后選擇更多操作圖標(biāo) 更多操作圖標(biāo) 。
  2. 選擇創(chuàng)建分叉。
您還可以通過在環(huán)境概覽選項(xiàng)卡中選擇分叉 來(lái)分叉環(huán)境。

您可以編輯您的環(huán)境分支并根據(jù)需要使用它,或者您可以創(chuàng)建拉取請(qǐng)求來(lái)更新原始環(huán)境。

查看拉取請(qǐng)求、分叉和環(huán)境詳細(xì)信息

您可以從右側(cè)邊欄查看所有拉取請(qǐng)求、分支和有關(guān)環(huán)境的詳細(xì)信息。

  • 要查看拉取請(qǐng)求,請(qǐng)選擇拉取請(qǐng)求圖標(biāo) 拉取請(qǐng)求圖標(biāo)
  • 要查看分叉,請(qǐng)選擇分叉圖標(biāo) 分叉圖標(biāo)
  • 要查看有關(guān)環(huán)境的其他信息,包括其 ID、創(chuàng)建者以及使用它的任何模擬服務(wù)器或監(jiān)視器,請(qǐng)選擇信息圖標(biāo) 信息圖標(biāo)

如果您對(duì)環(huán)境具有編輯訪問權(quán)限,則可以查看拉取請(qǐng)求并將更改合并到父環(huán)境中。

下一步

共享環(huán)境允許您在 Postman 中利用協(xié)作。查看更多有關(guān)如何與團(tuán)隊(duì)成員合作處理 API 開發(fā)項(xiàng)目的資源:

  • 要了解有關(guān)如何與您的團(tuán)隊(duì)一起使用 Postman 的更多信息,請(qǐng)?jiān)L問在 Postman 中進(jìn)行協(xié)作。
  • 要了解有關(guān)如何在 Postman 中創(chuàng)建工作區(qū)的更多信息,請(qǐng)?jiān)L問工作區(qū)簡(jiǎn)介。
  • 要了解有關(guān)如何共享 API 訪問權(quán)限的更多信息,請(qǐng)?jiān)L問管理和共享 API。
  • 要了解如何使用版本控制來(lái)協(xié)作構(gòu)建 API,請(qǐng)?jiān)L問Postman 中的版本控制。


以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)