1. 概述
Postman 是一款流行的 API 開發工具,它簡化了 API 的設計、測試、修改和文檔編寫過程。它提供了一個 用户友好的界面,允許用户發送和接收 HTTP 請求,使用環境和集合管理工作流程,執行自動化測試,創建模擬服務器進行測試,並生成 API 文檔。
由於其多功能性,它深受開發人員、測試人員和其他從事 API 驅動工作流程的 IT 專家推崇。
在本教程中,我們將討論如何安裝、配置和使用 Postman 的最重要的功能。
2. 安裝與設置
Postman 可作為桌面應用程序下載,適用於 Windows、Mac 或 Linux 操作系統。您可以在 這裏 下載。 此外,它還提供作為 Web 應用程序。 但請注意,並非所有功能在該應用程序中可用。
安裝完成後,您需要註冊並創建一個免費賬户。
3. 發送 HTTP 請求
在 Postman 中,發送請求到 API 是一個基本操作。 Postman 提供了一系列 免費公共 REST API,無需任何身份驗證,我們將利用這些 API 來演示 Postman 的一些功能。
我們將使用 API 來檢索特定國家的大學和大學。
讓我們創建一個名為 “baeldung-test-workspace” 的工作區。 創建後,我們可以點擊 “新建” 按鈕並選擇 “HTTP”。
為了在 Postman 中測試發送請求,我們將 URL 設置為 http://universities.hipolabs.com/search?country=Germany,並將方法設置為 GET:
發送請求後,Postman 將在側邊欄顯示響應數據。 您可以在此處查看狀態碼、標頭和響應正文。
如果未收到成功的響應,側邊欄中的狀態碼和詳細信息將有助於識別問題。
在本示例中,我們使用的是 GET 方法,但根據場景,我們可以選擇其他常見的方法,例如 POST、PUT、PATCH、DELETE,或者輸入新方法。
我們還使用了查詢參數來指定國家名稱。 當使用查詢參數時,它們可以在請求 URL 中輸入,也可以在“Query params” 選項卡中輸入,其中可以作為鍵值對輸入。 Postman 默認支持路徑參數,這些參數也作為請求 URL 的一部分輸入。
4. 環境
有效地管理跨不同環境的請求可能很複雜。但是,Postman 的環境允許我們為不同的環境管理變量,從而輕鬆地在開發、測試和生產等環境之間切換。
讓我們通過點擊 新建 按鈕並選擇 環境:開發和測試 創建兩個不同的環境:
在這裏,我們可以輸入初始值和當前值。初始值是變量的默認設置,而當前值是在變量被引用時實際使用的值。當保存環境時,如果將當前值留空,則初始值將用作當前值。
我們將在每個環境中創建一個名為 country 的變量,為開發環境分配值為“Germany”,為測試環境分配值為“France”:
我們選擇右上角的 開發 環境,然後點擊 發送 按鈕。 country 的值被解析為“Germany”。 變量不僅限於查詢參數,還可以引用在請求 URL、標頭和主體數據中。
5. 集合 (Collections)
管理 API 中各種方面的單個請求可能在有效組織方面帶來挑戰。此外,當 API 的參數在不同環境中存在差異時,需要在不同環境中執行相同的請求,而無需進行修改。
這正是集合發揮作用的地方,它們有助於更有效地管理 API 工作流。 集合可以與特定環境相關聯,從而允許我們在請求中使用環境變量。
在 API 工作流中,按照特定順序執行多個請求通常是必要的,集合可以通過執行請求的特定順序來幫助您。
總的來説,集合是一種有效的方法,用於將請求分組,以便更輕鬆地進行管理和團隊成員之間的協作。
5.1. 創建集合
點擊 創建集合 按鈕或保存現有的 GET 請求。 我們還將添加一個 GET 請求,用於檢索所有位於法國的學院和大學,並將其保存到新集合中。
通過在左側側邊欄上點擊集合的名稱,我們看到多個選項卡,每個選項卡允許我們自定義和配置集合,例如通過添加將在每個請求中執行的測試。
5.2. 收集器 (Collection Runner)
我們將重點關注通過利用 收集器 執行我們的收集 (collection)。 在這裏,我們可以以特定順序運行我們的請求,手動、按計劃或從命令行運行。 這種方式可以測試我們的 API 的功能性。 儘管如此,收集器 還允許我們通過模擬真實世界的流量場景來測試我們的 API 的性能。
收集器 還可以以多種方式進行配置,但為了演示目的,我們將保持簡單,只選擇手動運行選項。
最後,可以通過點擊 運行收集 (collection) 測試 按鈕來運行收集 (collection):
現在,我們可以查看收集 (collection) 運行的結果。 Postman 將顯示執行的請求的結果以及如果包含任何測試結果,最終的測試結果。 在這裏,我們可以查看有用的信息,例如環境、持續時間、平均響應時間以及每個請求的結果。
6. 概述
本文介紹了 Postman – 一款強大的 API 工作工具。
我們討論瞭如何發送 HTTP 請求、將變量分組到可以引用於請求中的環境,以及將請求分組為集合等基本內容。然而,這只是 Postman 功能的冰山一角。例如,通過集合進行自動化測試和創建用於測試的模擬服務器等高級功能,可以顯著提升我們的 API 開發流程,尤其是在處理複雜場景時。