API Academy
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
HomePetstore APIExplore more APIs
HomePetstore APIExplore more APIs
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
  1. Working with APIs
  • 歡迎
  • 目錄
  • API 學院
    • Get Started
      • 什麼是 API?
      • API 如何運作?
      • 如何呼叫 API?
      • 如何閱讀 API 文件?
      • 章節總結
    • API Fundamentals
      • API 基礎知識:概覽
      • 方法與路徑
      • 參數
      • 請求 Body
      • 回應
      • API 規格與 OAS
      • 章節總結
    • Working with APIs
      • 使用 API:概覽
      • 根據規格發送請求
      • 環境與變數
      • 串聯多個端點
      • 處理 Auth
      • 處理 API 簽名
      • 腳本介紹
      • 章節總結
    • Mocking APIs
      • Mocking API:概覽
      • Smart Mock
      • Mock 預期結果
      • Cloud Mock
      • Mock 腳本
      • 章節總結
    • Designing APIs
      • 設計 API:概覽
      • API 設計介紹
      • 建立您的第一個 API 專案
      • 分析需求並規劃您的 API
      • 設計資料模型
      • 設計端點
      • 使用組件與可重用性
      • 設定與 Auth
      • API 設計指南
      • 章節總結
    • Developing APIs
      • 開發 API:概覽
      • 設定:安裝您的 AI 程式碼助手
      • 快速入門:30 分鐘內從規格到運行的 API
      • 了解生成的程式碼
      • 使用 Apidog 測試您的 API
      • 部署:將您的 API 上線
      • 章節總結
    • Testing APIs
      • 測試 API:概覽
      • 快速入門:您的第一個測試場景
      • 整合測試與資料傳遞
      • 動態值
      • 斷言與驗證
      • 流程控制:If, For, ForEach
      • 資料驅動測試
      • 性能測試
      • 測試報告與分析
      • CI/CD 整合
      • 排程任務與自動化
      • 進階測試策略
      • 章節總結
    • API Documentations
      • API 文件:概覽
      • 發布您的第一個 API 文件
      • 自訂文件外觀
      • 給消費者的互動功能
      • 進階發布設定
      • 管理 API 版本
      • 章節總結
    • Advanced API Technologies
      • 進階 API 技術:概覽
      • GraphQL
      • gRPC
      • WebSocket
      • Socket.IO
      • Server-Sent Events
      • SOAP
      • 章節總結
    • API Lifecycle
      • API 生命周期:概覽
      • API 生命周期的階段
      • API 治理
      • API 安全最佳實踐
      • 監控與分析
      • API 版本策略
      • API 的未來
      • 章節總結
    • API Security
      • API 安全性:概覽
      • API 安全性基礎知識
      • 身份驗證 vs. 授權
      • 了解 OAuth 2.0 和 OpenID Connect
      • JSON Web Tokens (JWT)
      • OWASP API 安全 Top 10
      • 加密與 HTTPS
      • 章節總結
    • API Tools
      • API 工具:概覽
      • API 工具的演變
      • API Clients
      • 命令列工具 (cURL, HTTPie)
      • API 設計和文件工具
      • API Mocking 工具
      • API 測試工具
      • 一體化 API 平台
      • 章節總結
    • API Gateway
      • API Gateway:概覽
      • 什麼是 API Gateway?
      • API Gateway 的關鍵功能
      • API Gateway vs 負載平衡器 vs 服務網格
      • 流行 API Gateway 解決方案
      • BFF (Backend for Frontend) 模式
      • 章節總結
HomePetstore APIExplore more APIs
HomePetstore APIExplore more APIs
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
  1. Working with APIs

根據規格發送請求

在前面的章節中,我們探討了 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})。
3.
點擊它以打開端點詳細資訊。

步驟 2:切換到 Run 分頁#

一旦打開端點,您將在頂部看到多個分頁:
Edit — 用於查看或修改端點規範
Run — 用於發送請求
Preview — 用於以不同格式查看規範
點擊 "Run" 分頁切換到請求介面。
image.png

步驟 3:填寫路徑參數#

在 Run 分頁中,您將看到請求是根據規範自動生成的。對於 GET /pets/{id} 端點:
Method 已經設定為 GET
Path 顯示 /pets/{id},其中路徑參數 {id} 被高亮顯示
如果規範包含範例值(如 '1'),它可能已經填入
在路徑參數欄位中輸入寵物 ID。例如,輸入 pet_1Nv0FGQ9RKHgCVdK 以檢索具有該 ID 的寵物。
image.png

步驟 4:發送請求#

1.
確保您已在右上角選擇了正確的 環境(如果您的專案使用環境)。
2.
點擊 "Send" 按鈕。
3.
回應將顯示在下方的面板中,顯示狀態碼、回應時間,以及包含寵物資訊的 JSON Body。

2. 從規範發送 POST 請求#

現在讓我們嘗試一個更複雜的範例:使用 POST 請求 和 請求 Body 建立新寵物。這顯示了如何處理需要發送資料的端點。

步驟 1:打開端點#

1.
導航到您 Apidog 專案中的 "Create a pet" 端點(或 POST /pets)。
2.
點擊它以打開端點。

步驟 2:切換到 Run 分頁#

點擊 "Run" 分頁以存取請求介面。

步驟 3:審查自動生成的請求 Body#

當您切換到 Run 分頁時,Apidog 會根據規範的 Schema 自動生成請求 Body。如果規範包含範例,它將被預填。否則,您將看到與 Schema 匹配的結構。
image.png

步驟 4:填寫請求 Body#

建立寵物的請求 Body 通常包括以下欄位:
name — 寵物的名字(例如 "Luna")
species — 寵物的物種(例如 "DOG", "CAT")
breed — 寵物的品種(例如 "Golden Retriever")
ageMonths — 寵物的年齡(以月為單位)
status — 寵物的狀態(例如 "AVAILABLE", "PENDING", "ADOPTED")
您可以:
直接在 JSON 編輯器中 編輯自動生成的值
點擊 "Auto-generate" 根據 Schema 建立新範例資料
手動輸入 您自己的值
範例請求 Body:
{
  "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:發送請求#

1.
驗證您的請求 Body 格式正確。
2.
點擊 "Send" 建立寵物。
3.
檢查回應——您應該收到 201 Created 狀態和已建立寵物的資訊,或者看到任何錯誤訊息(如果出錯)。

3. 儲存為端點案例(可選)#

發送成功請求後,您可以將其儲存為 端點案例 以供將來使用:
1.
點擊 "Save as case" 按鈕(位於 "Send" 按鈕旁邊)。
2.
在出現的對話框中:
輸入案例名稱(例如 "Get pet by ID - Luna")
可選:勾選 "Save response" 以同時儲存回應資料
3.
點擊 "Save"。
已儲存的案例將顯示在專案樹狀結構中的端點下方,使您可以輕鬆地在以後重複使用此特定請求配置。
image.png

4. 關鍵重點#

使用 API 工作 是關於使用 API 組件來解決實際問題和構建功能。
從規範工作 透過自動生成請求來確保準確性並節省時間。
在 Apidog 中發送請求:
1.
匯入 API 規範(如果尚未完成)
2.
打開您想要使用的端點
3.
切換到 "Run" 分頁
4.
填寫任何所需的參數或請求 Body
5.
點擊 "Send" 執行請求
6.
可選:點擊 "Save as case" 以儲存請求供將來使用
GET 請求 通常使用路徑或查詢參數。
POST 請求 通常需要帶有結構化資料的請求 Body。
端點案例 允許您儲存特定請求配置以供重複使用。
Apidog 根據規範自動生成請求,使正確測試 API 變得容易。

現在您知道如何從規範發送基本請求,您準備好探索構建現實世界解決方案的更進階技術。在下一篇文章中,我們將學習 環境和變數——如何管理不同環境並使用變數使您的請求更靈活和可重複使用。
Modified at 2025-12-29 10:41:16
Previous
使用 API:概覽
Next
環境與變數
Built with