API 基礎知識：概覽

當您開始使用 API 工作時——無論是設計它們、記錄它們，還是將它們整合到應用程式中——了解構成每個請求和回應的核心建構模組會很有幫助。雖然 API 有許多種風格，但大多數都遵循相同的基本結構：清晰的路徑、可預測的輸入格式和一致的輸出訊息。

在這個系列中，我們將這些重要部分分解為簡單、重點突出的文章：

方法與路徑 – API 如何定義您正在執行什麼操作以及在哪裡執行它。

參數 – 微調您的請求的可選或必要細節。

請求 Body – 隨特定 HTTP 方法（例如 POST 或 PUT）發送的結構化資料。

回應 – 伺服器返回什麼，包含狀態碼和資料負載 (payload)。

每篇文章都專注於一個組件，並使用 Pet Store API 進行實際範例演示，這是一個在教學和工具範例中廣泛使用的經典示範 API。

探索完每個 API 組件後，我們將以介紹 API 規格 來總結本系列，重點介紹 OpenAPI 規格 (OAS)。您將學習 OAS 如何提供一種標準方法來描述端點、參數、請求 Body、回應等——所有這些都在一個單一的結構化文件中。使用 Pet Store API 的範例，我們將展示這些基礎部分如何在 OAS 文件中組合在一起，使 API 更容易設計、記錄和使用。

關於 Pet Store API

Pet Store 是一個模擬簡單線上寵物管理系統的 Mock API。即使它不是真實的服務，它也提供了逼真的端點和資料結構，使其成為完美的學習工具。

Pet Store API 包含常見的操作，例如：

每個端點演示了典型的 RESTful API 概念，包含路徑參數、查詢參數、JSON 請求 Body、JSON 回應和標準 HTTP 狀態碼。

因為這個 API 故意設計得很簡單、易于測試且文件齊全，所以它非常適合說明現代 API 是如何結構化的——特別是在 Apidog 等工具中學習 API 設計、除錯或文件工作流程時。

準備好開始了嗎？讓我們驗證第一個建模組：方法與路徑。

API 基礎知識：概覽

關於 Pet Store API#

關於 Pet Store API