使用變數

在 Apidog 中，變數可讓你輕鬆儲存並重複使用值。將值儲存為變數後，你就能在各種環境、請求、腳本和測試情境中存取它。使用變數可提升生產力，並促進同事之間的團隊合作。

什麼是變數？

變數是資料的符號化表示，可讓你在需要時擷取值，而不必每次都手動輸入。這有助於在不同位置重複使用相同的值。

範例：
如果你在多個請求中使用相同的 token，並預期它可能會變更，請將該 token 儲存為名為 {{my_token}} 的變數。在請求參數值中使用 {{my_token}}。當 token 變更時，更新變數值即可在所有地方同步更新。

變數可在參數值、主體、URL 或標頭中生效。

在 Apidog 的 Tests 模組中，變數可用於在請求之間傳遞資料。

變數作用域

Apidog 支援多種作用域的變數，以配合不同的開發、測試與協作需求。

優先順序（由低到高）：Global < Module < Environment < Data < Local

當不同作用域中定義了相同名稱的變數時，會優先使用最窄作用域的值。

全域變數

專案內共享：可在整個專案中存取。適合在端點之間共享資料（例如：登入 token）。

團隊內共享：可在整個團隊的不同專案之間共享（例如：登入專案與財務專案之間共享的 token）。

NOTE

權限：若要管理團隊變數，你需要團隊管理員權限。前往 Team Resources > Variables。

腳本：你可以使用 pm.globals.set 在腳本中更新本機值，但無法變更名稱或共享值。

模組變數

定義於模組內。從 Postman 匯入「Collection variables」時，會對應為 Module variables。

環境變數

綁定至特定環境（Development、Testing、Production）。只有目前啟用環境的變數會生效。

資料變數

來源為 Test Scenarios 或 CLI 中的外部 CSV 或 JSON 檔案。值在執行結束後不會保留。

本機變數

僅限於單一請求或測試情境執行期間的暫時變數。完成後即會消失。

TIP

Apidog 中的變數會以字串形式儲存。儲存物件或陣列時，請使用 JSON.stringify() 儲存，並使用 JSON.parse() 擷取。

共享值與本機值

每個變數都有兩種狀態：

共享值：與 Apidog 伺服器同步，並與團隊共享。

本機值：儲存在你瀏覽器或客戶端快取中的本機值。不會共享。

最佳實務：

對敏感資料（token、密碼）使用本機值，讓它們保留在你的裝置上。

將本機值留空，以回退使用共享值。

點擊連結圖示 🔗，將本機值與共享值同步。

WARNING

清除 Apidog 快取會刪除本機值。

切換裝置時，本機值不會自動遷移（請使用環境匯出/匯入）。

在 Apidog CLI 中使用變數

在 CLI 中執行時，預設會使用共享值，而 Client 則使用本機值。這是 Client 與 CLI 執行結果出現差異的常見原因。

TIP

深入了解 Apidog CLI。

定義變數

1. 環境管理（預設）

Global 和 Environment 變數的值可手動預先設定。

點擊 Environment Management 圖示 ≡。

選擇 Global Variables 或特定環境。

新增變數名稱、共享值與本機值。

點擊 Save。

2. 擷取變數

無需撰寫程式碼，即可從 API 回應中以視覺化方式擷取值並存入變數。

在 Run 分頁（Design Mode）中，前往 Post Processors。

選擇 Extract Variable。

設定擷取來源（JSON、XML、Header 等）與 JSONPath。

傳送請求以執行，並在 Console 中驗證。

TIP

深入了解 Extract Variable。

3. 腳本

在 Pre/Post-processors 中使用 pm 物件。

set 的語法：

儲存物件/陣列：

TIP

深入了解腳本語法。

4. 資料庫操作

連線至資料庫以擷取資料，並將其設為變數。

在 Post Processors 中新增 Database Operation。

設定資料庫連線。

輸入 SQL 命令（支援 {{variable}}）。

設定 Extract Result To Variable。

TIP

深入了解資料庫操作。

請求參數

在 URL、參數、標頭或主體中使用雙大括號 {{variable}}。

URL 範例：
http://127.0.0.1/pet/findByStatus?status={{CurrentStatus}}

JSON 主體範例：

{
    "status": "{{CurrentStatus}}",
    "quantity": {{TotalPet}}
}

WARNING

字串：字串變數周圍請加上雙引號 ""（例如："{{name}}"）。

數字/布林值：請勿加上引號（例如：{{count}}）。

存取子元素

如果變數包含 JSON 物件/陣列，請使用 JSONPath 透過點記法存取屬性。

{{user}} 中的物件：

{ "id": 1, "name": "Jack" }

請求：{{user.name}}

腳本：pm.variables.get("user.name")

{{users}} 中的陣列：

[ { "name": "Jack" } ]

請求：{{users[0].name}}

腳本：pm.variables.get("users[0].name")

在腳本中使用變數

在腳本中，請使用 pm.*.get()，而不是 {{}}。

記錄日誌：

查看 Console 分頁以檢視輸出。

使用資料變數

在 Test Scenarios 中，匯入 CSV/JSON 檔案會建立「Data Variables」。使用 {{column_name}} 來引用它們。檔案中的每一列都會觸發一次獨立迭代。

TIP

深入了解資料驅動測試。

FAQ

Q：我可以在 Mocks 中使用變數嗎？

不可以。 變數是在傳送請求時解析的。Mocks 是靜態定義，或在 mock 伺服器上執行，並不以相同方式具備客戶端「傳送」情境。

Q：如何在腳本中取得 base URL？

使用 pm.request.getBaseUrl()。

避免使用 pm.environment.get('BASE_URL')，因為對於非預設伺服器端點而言，它可能不準確。

使用變數

什麼是變數？#

變數作用域#

共享值與本機值#

在 Apidog CLI 中使用變數#

定義變數#

1. 環境管理（預設）#

2. 擷取變數#

3. 腳本#

4. 資料庫操作#

使用變數#

請求參數#

存取子元素#

在腳本中使用變數#

使用資料變數#

FAQ#

什麼是變數？

變數作用域

共享值與本機值

在 Apidog CLI 中使用變數

定義變數

1. 環境管理（預設）

2. 擷取變數

3. 腳本

4. 資料庫操作

使用變數

請求參數

存取子元素

在腳本中使用變數

使用資料變數

FAQ