[API] #2 Postman ‐ 測試 API 神器 - antqtech/KM GitHub Wiki

本篇重點：

  • Postman 介紹

  • 請求方法 - GET 和 POST 差異

  • 取得回傳資料

  • 輸出資料

Postman 介紹

Postman 是一款用於測試和開發 API 的流行工具，它提供了直觀的用戶界面，讓開發者能夠輕鬆地創建、發送和測試 API 請求，並查看請求的回應。Postman 幫助開發人員在不同的開發階段中進行 API 的測試、調試和驗證，從而提高開發效率並確保 API 的正確運作。

以下是一些 Postman 的主要功能和特點：

  1. 請求創建和測試: 使用 Postman，您可以輕鬆地創建各種類型的 API 請求，如 GET、POST、PUT、DELETE 等。您可以設定請求標頭、參數、主體和其他相關信息，然後立即發送請求以測試 API 的回應。

  2. 腳本和自動化: Postman 允許您使用 JavaScript 編寫腳本，可以在請求之間共享數據、執行驗證、自動化工作流程等。這對於模擬複雜的使用情境或自動化測試非常有用。

  3. 環境和變數: 您可以在 Postman 中創建環境，然後定義變數，這些變數可以在不同的請求之間共享，使得在不同的環境中進行測試更加便捷。

安裝

官方網站：https://www.postman.com/downloads/

Download Postman

開始測試 API

  • Import 加入已經有的 json 檔，也可以不加，自行建立新的

Import

  • Create new collection，取名為 Test（可以自訂）

Create new collection

  • 點 + 建立新的請求，這裡請求方法用 POST 做示範

New request

  • 請求方法 - GET 和 POST 差異

由於上一篇有詳細介紹過，這裡說明常用的 GET 和 POST 的差異：

參數傳遞位置 參數量限制 安全性
GET 參數會用字串附加在 URL 的末尾 參數較少，受限於 URL 長度 參數顯示在 URL 上，容易被竊取
POST 參數包含在請求內 參數較多，因為存放在請求中，不受 URL 長度限制 參數不會在 URL 上，較為安全

Post

  • 建立 URL，伺服器網址/API 路徑，如果有之前建立過的請求會顯示在下面，可以直接點選使用

URL

  • Params 是設置 URL 查詢字串參數的功能。URL 查詢字串在 URL 中以 ? 開頭，後面跟著一系列的鍵值對，通常用來查詢、排序或篩選

params

  • Body 是用於設置請求主體的功能，用於向伺服器提交表單資料、JSON 或 XML 格式的資料

這裡填寫在 raw 用 JSON 舉例

Body

在寫 JSON 前，需要去 Headers 設定，添加 Content-Type，設置值為 application/json，告訴伺服器我們正在傳遞 JSON 格式的資料

Headers

回到 Body，輸入 JSON 格式的資料

{
    "name": "John Doe",
    "email": "[email protected]",
    "password": "securepassword"
}

Raw

取得回傳資料

  • 按下 Send 送出，並取得回傳的數據，顯示在 Body

Send

  • Status 狀態碼，表示 API 回應狀況，常見如下

  1. 200 | 成功取得回應

  2. 400 | 請求參數錯誤 (檢查輸入的參數，是否符合 API 規定）

  3. 401 | 未認證 (未登入認證，但 API 有請求需要登入）

  4. 404 | 請求的資源不存在 （新手常見是，URL 打錯）

  5. 500 | 內部 Server 出錯 （可能是 Server 掛掉了）

  • 點選 Save 儲存 Request，在想要的 collection/folder 裡面，取名為 TestRequest（可自訂）

Save

Save request

輸出資料

點選 collection/folder 右邊的三個點，選擇 Export 輸出成 JSON 檔

Export

Export collection