1. 概述
Postman 是一款流行的 API 開發工具,它簡化了 API 的設計、測試、修改和文檔編寫。它提供 一個用户友好的界面,允許用户發送和接收 HTTP 請求,使用環境和集合管理工作流程,執行自動化測試,創建 Mock 服務器進行測試,並生成 API 文檔。
由於其多功能性,它深受開發人員、測試人員和其他從事 API 驅動工作流程的 IT 專家推崇。
在本教程中,我們將討論如何安裝、設置和使用 Postman 的最重要的功能。
2. 安裝與設置
Postman 可作為桌面應用程序下載,適用於 Windows、Mac 或 Linux 操作系統。訪問 此處 下載。 此外,它還作為 網絡應用程序 提供。 但是,並非所有功能在該應用程序中可用。安裝完成後,您需要註冊並創建一個免費帳户。
3. 發送 HTTP 請求
在 Postman 中發送請求是基本操作之一。 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 中或在“查詢參數”選項卡中輸入,其中可以作為鍵值對輸入。 Postman 默認支持路徑參數,這些參數也作為請求 URL 的一部分輸入。
4. 環境
有效地管理跨不同環境的請求可能很複雜。但是,Postman 的環境使我們能夠管理不同環境的變量, 從而輕鬆地在開發、測試和生產等環境之間切換。
讓我們通過點擊 新建 按鈕並選擇 環境:開發和測試” 創建兩個不同的環境:
在這裏,我們可以輸入初始值和當前值。 初始值是變量的默認設置,而當前值是在變量被引用時實際使用的值。 如果保存環境時,當前值為空,則初始值將用作當前值。
我們將為每個環境創建一個名為 country 的變量,並將開發環境的值設置為“Germany”,並將測試環境的值設置為“France”:
我們選擇了右上角的 開發 環境,然後點擊了 發送 按鈕。 country 的值被解析為“Germany”。 變量不僅限於查詢參數,還可以引用在請求 URL、標頭和主體數據中。
5. 收集
管理各種 API 方面個別請求在有效組織方面可能具有挑戰性。 此外,參數在不同環境中差異的 API 需要在不修改的情況下在不同環境中執行相同的請求集。
這就是收集的幫助所在,因為它們有助於更有效地管理 API 工作流程。 收集可以與特定環境相關聯,允許我們在請求中使用環境變量。
在 API 工作流程中,執行特定順序的多個請求通常是必要的,收集可以幫助通過執行特定順序的請求。
一般來説,收集是更輕鬆地管理和團隊成員之間協作的有效方法來分組請求。
5.1. 創建收集
讓我們通過單擊 創建收集 按鈕或保存現有 GET 請求來創建一個新收集。 我們還將保存一個用於檢索法國所有學院和大學的 GET 請求並將其保存到新收集中。
通過在左側邊欄中單擊收集的名稱,我們看到多個選項卡,每個允許我們自定義和配置收集,例如通過添加將與每個請求執行的測試。
5.2. 收集運行器
現在我們將通過利用 收集運行器 來運行我們的收集,其中我們可以以特定順序運行請求,手動、按計劃或從命令行運行它。 這樣我們可以測試 API 的功能方面。 然而,收集運行器 還允許我們通過模擬現實世界的流量場景來測試 API 的性能。
收集運行器 可以以各種方式進行配置,但為了演示目的,我們將保持簡單並僅選擇手動運行選項。
最後,可以通過單擊 運行測試收集 按鈕運行收集:
現在,我們可以查看收集運行的結果。 Postman 將顯示執行的請求和任何包含的測試結果。 在這裏,我們可以查看有用的信息,例如環境、持續時間、平均響應時間以及每個請求的結果。
6. 總結
在本文中,我們討論了 Postman – 一種強大的用於與 API 交互的工具。
我們涵蓋了如何發送 HTTP 請求、將變量分組到可以引用於發送請求的環境中,以及將請求分組為集合的基本內容。但這只是 Postman 功能的冰山一角。高級功能,如通過集合進行自動化測試和創建用於測試的模擬服務器,可以顯著增強我們的 API 開發流程,尤其是在處理複雜場景時。