郵差簡介
1. 概述
Postman 是一種流行的 API 開發工具,可簡化 API 的設計、測試、修改和文件記錄。它提供了一個用戶友好的介面,允許用戶發送和接收 HTTP 請求、管理環境和集合的工作流程、執行自動化測試、創建用於測試的模擬伺服器以及生成 API 文件。
由於其多功能性,它受到開發人員、測試人員和其他從事以 API 為中心的工作流程的 IT 專業人員的高度重視。
在本教程中,我們將討論如何安裝、設定和使用 Postman 最重要的功能。
2. 安裝與設定
Postman 可以作為 Windows、Mac 或 Linux 作業系統的桌面應用程式下載。它也可以作為網路應用程式提供。但是,並非所有功能都可用。
安裝後,我們必須註冊並建立免費帳戶。
3. 發送HTTP請求
Postman 的基本操作之一是向 API 發送請求。 Postman 提供了一組不需要任何驗證的免費公共 REST API ,我們將利用這些 API 來示範 Postman 的一些功能。
我們將使用 API 來檢索特定國家的學院和大學。
讓我們建立一個名為“baeldung-test-workspace”.
建立後,我們可以點擊New
按鈕並選擇HTTP
。
為了測試在 Postman 中發送請求,我們將 URL 設定為http://universities.hipolabs.com/search?country=Germany
並將方法設為 GET:
發送請求後,Postman 會在側邊欄中顯示回應資料。我們可以在此處查看狀態代碼、標頭和回應正文。
如果我們沒有收到成功的回复,側邊欄中的回复狀態和詳細資訊將有助於識別問題。
在本例中,我們使用 GET 方法,但根據情況,我們可以選擇其他最常見的方法,例如 POST、PUT、PATCH、DELETE,或輸入新方法。
我們也使用了國家/地區名稱的查詢參數。使用查詢參數時,可以在請求 URL 中輸入它們,也可以在專用的查詢參數標籤中輸入它們,在其中可以將它們作為鍵值對輸入。 Postman 自然支援路徑參數,這些參數也作為請求 URL 的一部分輸入。
4. 環境
有效管理各種環境中的請求可能很複雜。然而, Postman 的環境允許我們管理不同環境的變量,使得開發、測試和生產之間的切換變得容易。
讓我們透過點擊New
按鈕並選擇Environment: development and test
來創建兩個不同的環境:
在這裡,我們可以輸入初始值和當前值。初始值是變數的預設設置,而當前值是在實際請求中引用該變數時使用的。如果我們在儲存環境時將目前值留空,則初始值將用作目前值。
我們將在每個國家創建一個變量,為開發環境指定“德國”,為測試環境指定“法國”:
我們選擇右上角的Development
環境,然後點擊Send
按鈕。該國的價值被認定為“德國”。這些變數不僅為查詢參數保留 – 它們可以在請求 URL、標頭和正文資料中引用。
5. 收藏
管理對 API 各個方面的單獨請求對於有效組織而言可能是一個挑戰。此外,不同環境中參數不同的 API 需要在不同環境中執行同一組請求,而無需進行修改。
這就是集合證明有用的地方,因為它們有助於更有效地管理 API 工作流程。集合可以與特定環境相關,允許我們在請求中使用環境變數。
在 API 工作流程中,通常需要以特定順序執行多個請求,而集合可以透過以特定順序執行請求來提供協助。
一般來說,集合是將請求分組的有效方法,以便於團隊成員之間的管理和協作。
5.1.建立集合
讓我們透過點擊Create Collection
按鈕或儲存現有的 GET 請求來建立一個新集合。我們還將添加一個 GET 請求來檢索法國的所有學院和大學並將其保存到這個新集合中。
透過點擊左側邊欄中的集合名稱,我們會看到多個選項卡,每個選項卡都允許我們自訂和配置我們的集合,例如新增將針對集合中的每個請求執行的測試。
5.2.收集賽跑者
現在,我們將專注於利用Collection Runner
來運行我們的集合,在這裡我們可以按特定順序運行我們的請求,可以手動、按計劃運行,也可以從命令列運行。我們可以透過這種方式測試 API 的功能。儘管如此, Collection Runner
也讓我們可以透過模擬真實的流量場景來測試 API 的效能。
可以透過各種方式進一步配置Collection Runner
,但為了演示目的,我們將保持簡單,並且僅選擇手動運行選項。
最後,可以透過點擊Run Test collection
按鈕來運行該集合:
現在,我們可以查看收集運行的結果。如果包含任何測試,Postman 將顯示執行請求的結果和最終的測試結果。在這裡,我們可以查看有用的信息,例如每個請求的環境、持續時間、平均回應時間和結果。
六、總結
在本文中,我們討論了 Postman——一個使用 API 的強大工具。
我們介紹如何傳送 HTTP 請求、將變數分組到發送請求時可以引用的環境以及將請求分組到集合中的要點。然而,這僅僅觸及了 Postman 廣泛功能的表面。高級功能,例如透過集合進行自動化測試以及建立模擬伺服器進行測試,可以顯著增強我們的 API 開發流程,尤其是在處理複雜場景時。