在前面的章節中,我們探討了 API 的理論基礎,並了解了它們的個別組件——方法、路徑、參數、請求 Body 和回應。現在,作為 API 世界的新手,是時候看看這些部分如何組合在一起構建真正的功能。本章重點關注 使用 API 工作——使用 API 解決實際問題和完成任務的實踐過程。我們將從最基本的技能開始:如何在 Apidog 中從 API 規範發送請求。與其從頭開始手動構建請求,從規範工作 確保您正確使用 API,並幫助您避免常見錯誤。如果您尚未將 API 規範匯入 Apidog,您可以在上一篇文章中學習如何操作:什麼是 API 規範?。
1. 從規範發送 GET 請 求#
讓我們從一個簡單的範例開始:使用 Pet Store API 透過其 ID 檢索寵物。這演示了如何處理包含 路徑參數 的 GET 請求。步驟 1:打開端點#
1.
在您的 Apidog 專案中,導航到已匯入的 Pet Store API 規範。
2.
找到 "Get a pet" 端點(或 GET /pets/{id})。
步驟 2:切換到 Run 分頁#
步驟 3:填寫路徑參數#
在 Run 分頁中,您將看到請求是根據規範自動生成的。對於 GET /pets/{id} 端點:Path 顯示 /pets/{id},其中路徑參數 {id} 被高亮顯示
在路徑參數欄位中輸入寵物 ID。例如,輸入 pet_1Nv0FGQ9RKHgCVdK 以檢索具有該 ID 的寵物。步驟 4:發送請求#
1.
確保您已在右上角選擇了正確的 環境(如果您的專案使用環境)。
3.
回應將顯示在下方的面板中,顯示狀態碼、回應時間,以及包含寵物資訊的 JSON Body。
2. 從規範發送 POST 請求#
現在讓我們嘗試一個更複雜的範例:使用 POST 請求 和 請求 Body 建立新寵物。這顯示了如何處理需要發送資料的端點。步驟 1:打開端點#
1.
導航到您 Apidog 專案中的 "Create a pet" 端點(或 POST /pets)。
步驟 2:切換到 Run 分頁#
步驟 3:審查自動生成的請求 Body#
當您切換到 Run 分頁時,Apidog 會根據規範的 Schema 自動生成請求 Body。如果規範包含範例,它將被預填。否則,您將看到與 Schema 匹配的結構。步驟 4:填寫請求 Body#
species — 寵物的物種(例如 "DOG", "CAT")
breed — 寵物的品種(例如 "Golden Retriever")
status — 寵物的狀態(例如 "AVAILABLE", "PENDING", "ADOPTED")
點擊 "Auto-generate" 根據 Schema 建立新範例資料
{
"name": "Luna",
"species": "DOG",
"breed": "Golden Retriever",
"ageMonths": 24,
"size": "LARGE",
"color": "Golden",
"gender": "FEMALE",
"goodWithKids": true,
"goodWithPets": true,
"adoptionFee": 150.00,
"description": "Friendly golden retriever looking for an active family",
"status": "AVAILABLE"
}
步驟 5:發送請求#
3.
檢查回應——您應該收到 201 Created 狀態和已建立寵物的資訊,或者看到任何錯誤訊息(如果出錯)。
3. 儲存為端點案例(可選)#
發送成功請求後,您可以將其儲存為 端點案例 以供將來使用:1.
點擊 "Save as case" 按鈕(位於 "Send" 按鈕旁邊)。
2.
可選:勾選 "Save response" 以同時儲存回應資料
已儲存的案例將顯示在專案樹狀結構中的端點下方,使您可以輕鬆地在以後重複使用此特定請求配置。
4. 關鍵重點#
使用 API 工作 是關於使用 API 組件來解決實際問題和構建功能。
從規範工作 透過自動生成請求來確保準確性並節省時間。
6.
可選:點擊 "Save as case" 以儲存請求供將來使用
POST 請求 通常需要帶有結構化資料的請求 Body。
Apidog 根據規範自動生成請求,使正確測試 API 變得容易。
現在您知道如何從規範發送基本請求,您準備好探索構建現實世界解決方案的更進階技術。在下一篇文章中,我們將學習 環境和變數——如何管理不同環境並使用變數使您的請求更靈活和可重複使用。 Modified at 2025-12-29 10:41:16