iT邦幫忙

2024 iThome 鐵人賽

DAY 24
0
生成式 AI

API: Swagger, Postman系列 第 24

如何使用 Postman 的環境變量管理多個 API 環境。

  • 分享至 

  • xImage
  •  

在使用 Postman 時,環境變量可以幫助你在不同的 API 環境(例如開發、測試、和生產環境)之間靈活切換,而不需要手動更改請求的 URL 或其他參數。以下是如何使用 Postman 的環境變量來管理多個 API 環境的步驟:

1. 創建環境

  • 打開 Postman,點擊右上角的「齒輪」圖標,然後選擇「Manage Environments」。
  • 在彈出的窗口中,點擊「Add」按鈕,為每個環境創建一個新的環境,例如「開發環境」、「測試環境」和「生產環境」。
  • 為每個環境定義對應的變量(如 API URL、密鑰等)。例如:

2. 設置環境變量

  • 當創建或編輯環境時,輸入變量名稱和對應的值。例如,針對不同的環境,你可以設置:
    • base_url: API 的基礎 URL。
    • api_key: API 授權密鑰。
    • user_id: 測試用戶的 ID。

3. 在請求中使用變量

  • 在 Postman 的請求中,使用 {{變量名稱}} 調用環境變量。例如,使用 {{base_url}}/users 作為 API 的 URL,其中 {{base_url}} 將會根據你選擇的環境被動態替換為對應的值。
  • 如果你的請求中還有其他參數(例如 {{api_key}}),可以使用相同的方式在請求標頭、參數中引用。

4. 切換環境

  • 在請求的右上角,有一個「環境選擇」的下拉菜單,當你完成對不同環境的設置後,可以在這裡快速選擇你需要的環境。
  • 選擇不同的環境後,所有用到的變量會自動根據當前選中的環境進行替換。

5. 全局變量

  • 如果有一些變量是跨所有環境通用的,你也可以使用 Postman 的全局變量來設置。在「Manage Environments」窗口中,點擊「Globals」來添加全局變量。

6. 動態變量

  • Postman 還支持一些內建的動態變量,如 {{$guid}}{{$timestamp}} 等,用於自動生成唯一值或時間戳等內容,這些變量無需手動設置。

範例

假設你在「開發環境」和「生產環境」中分別有不同的 API URL 和密鑰:

  • 開發環境:
    • base_url: https://dev-api.example.com
    • api_key: dev-123456
  • 生產環境:
    • base_url: https://api.example.com
    • api_key: prod-abcdef

你的請求 URL 可以是 {{base_url}}/users,並且在 Authorization header 中可以使用 {{api_key}}。根據你選擇的環境,這些變量會自動被替換為對應的值。

通過這種方式,可以輕鬆管理多個 API 環境,而不需要每次手動更改請求中的 URL 或憑證。


上一篇
使用 Postman 測試 Swagger 定義的 API。
下一篇
在實際項目中應用 Postman:API 測試的最佳實踐。
系列文
API: Swagger, Postman30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言