Postman 變量指南
一、概述
在 Postman 中,變量讓我們可以保存值並在不同的 API 中根據需要使用它們。我們可以通過將它們傳遞給集合、環境或任何請求來引用這些值。它基本上使使用這些變量更有效地訪問存儲的值變得更容易。我們還可以與多個隊友協作或使用這些變量在 Postman 上設置動態工作流程。
在本文中,我們將深入了解變量、它們的類型以及如何將它們嵌入到我們的 API 中。
2.什麼是變量?
變量象徵著數據表示,讓我們無需在任何需要的地方手動輸入即可訪問值。當我們必須在多個地方使用相同的值時,它們會很有用。一些實例包括基本 URL、令牌和路徑變量。此外,使用它們還使請求更加靈活,因為更改變量將在所有使用這些變量的地方自動進行更改。
我們可以在 Postman 中將變量定義為鍵值對。 key 定義了變量名,允許我們使用這個 key 直接訪問它的值。
此外,還可以使用環境來設置一組變量。這些變量將根據環境具有不同的值。
讓我們深入研究變量並了解不同的變量範圍。
2.1。變量範圍
有多個範圍可以讓我們在具有不同值的各種環境中處理 API 的開發和測試。下面是從最寬到最窄的範圍定義的變量範圍:
- 全局變量:這些變量可以在整個工作區中訪問,並且在 Postman 中具有最廣泛的範圍。它們可以在工作空間內的多個請求和集合中的任何地方使用。
- 集合變量:這些變量只能在某個集合內部訪問。它們可用於集合中的所有請求。此外,它們不會根據所選環境而改變。
- 環境變量:這些變量讓我們根據不同的環境確定工作範圍。它們隨著我們正在處理的環境的變化而變化,例如本地環境、登台或生產環境。
- 數據變量:這些類型的變量是外部變量,在使用 Collection Runner 運行集合時定義數據集。我們可以從 CSV 或 JSON 文件中提取它。它們具有在請求或集合執行後不會持續存在的當前值。
- 局部變量:這些變量也稱為臨時變量,只能通過請求腳本訪問。它們僅在當前請求或集合之前具有範圍。執行完成後,它們將不再可用。
2.2.變量類型
全局變量和環境變量可以根據它們的類型進一步分類。以下是我們如何配置它們:
- 默認類型:變量默認屬於這些類型。這些顯示為沒有附加屬性的純文本。
- 秘密類型:這些變量隱藏所有工作區的初始值和當前值,類似於密碼。它們讓我們防止任何無意洩露敏感數據。
3. 使用範圍定義變量
如上所述,我們可以定義多種類型和範圍的變量。可以在請求生成器中的任何範圍內定義變量。
首先,我們選擇文本並單擊Set as a variable
。完成後,我們必須將其存儲為新變量。然後,我們為該值輸入一個鍵,並從 Postman 中可用的不同範圍中進行選擇:
3.1。將響應主體設置為變量
請求響應正文中的值也可以設置為變量並在集合中進一步使用。這有助於按順序運行多個請求並創建特定流。
首先,讓我們選擇要保存的文本,然後按right-click
或Control-click
按鈕將其存儲為變量。
完成後,我們必須從可能的選項中選擇相關範圍,即環境、本地或全局,並命名變量以保存它:
3.2.定義全局變量
下面看一下Postman中設置全局變量的步驟:
- 我們首先在全局變量部分點擊
Add a new variable
,然後輸入變量名直接存儲為全局變量。 - 另一個選項是通過選擇 Global 選項作為 Type 來選擇值並存儲變量。
- 一旦完成,我們不應該忘記標記 保存並確認更改。
我們還可以通過以下步驟下載全局變量並與他人共享:
- 首先,讓我們去 Postman 並在側邊欄中選擇環境類型為 Global。
- 然後,我們可以單擊將變量導出到文件的
Export
按鈕。 - 我們可以通過單擊來存儲文件一旦準備好
Save
在系統上,並根據需要共享。
3.3.定義環境變量
我們可以通過以下步驟在 Postman 中保存環境變量:
- 首先,我們點擊
Add a new variable
,然後輸入變量名稱。 - 在保存變量之前,我們可以選擇變量類型作為環境。
- 該變量需要指定初始值和當前值。
- 完成後,我們必須點擊 保存以確認更改。
3.4.定義集合變量
Postman 還提供了添加集合變量並根據需要使用它們的機會。
我們必須在側邊欄中單擊並選擇Collections
。完成後,讓我們選擇Variables
選項卡來存儲集合變量:
3.5 在腳本中定義變量
與在集合、環境或全局中定義變量類似,我們也可以在請求腳本中以編程方式設置變量。
所有這些方法都將( variable_key
, variable_value
)作為輸入:
-
pm.globals
:該方法用於定義請求腳本中的全局變量,例如pm.globals.set(“variable_key”, “variable_value”);
-
pm.collectionVariables
:我們可以用這個方法定義一個範圍為'collection'的變量,例如,pm.collectionVariables.set(“variable_key”, “variable_value”);
-
pm.environment
:這可用於定義範圍為當前環境的環境變量,例如pm.environment.set(“variable_key”, “variable_value”);
-
pm.variables
:這定義了具有本地/臨時範圍的局部變量,例如pm.variables.set(“variable_key”, “variable_value”);
-
unset
:此方法可用於刪除已設置的變量。 unset 可以根據它們的範圍使用上述變量實例定義,例如pm.environment.unset(“variable_key”, “variable_value”);
3.6 在腳本中使用變量
我們使用上述方法將變量存儲在腳本中。因此,我們可以使用以下方法檢索它們的當前值:
-
pm.variables.get(“variable_key”)
:這將訪問任何範圍內的變量,包括本地。 -
pm.globals.get(“variable_key”)
:這可以訪問全局變量 -
pm.collectionVariables.get(“variable_key”)
:這可以訪問集合變量。 -
pm.environment.get(“variable_key”)
:這可以訪問環境變量。
在這裡,我們可以使用variable_key
檢索值。該對象表示範圍級別, get()
方法檢索該值。
pm.variables.get()
方法還提供了在不實際影響腳本功能的情況下更改變量範圍的選項。它返回當前具有最高優先級的變量。
4. 使用變量
現在,我們已經定義了不同的變量範圍並學習瞭如何將它們存儲在 Postman 中。讓我們看看如何在我們的請求路徑和正文中使用這些變量。
為了在整個 Postman 中引用變量,我們應該在變量名周圍使用雙花括號。它會自動從定義的不同變量中獲取值。這是所有 Postman 的標準,不依賴於變量類型和範圍:
{{studentName}}
此外,運行 CURL 或點擊請求會解析變量並使用當前值更新變量。以下請求 URL 引用了該變量:
http://localhost:8080/get?student_name={{studentName}}
假設studentName
是“John”。 Postman 從其變量中檢索值並發送當前存儲在那裡的任何值。因此,在通過 Postman 發出上述請求時,它會自動將其轉換為請求:
http://localhost:8080/get?student_name=John
5. 結論
在本教程中,我們使用 Postman 變量使用 GUI 模式進行基本初始化。
此外,我們了解了它們的類型和範圍。此外,我們還查看了可以初始化它們的不同位置,例如 URI、請求正文和標頭。顯然,這讓我們無需多次初始化相同的值來節省時間和空間。