Apidog 用戶端支援使用 HTTP、GraphQL、SOAP、gRPC 以及其他常見協定傳送 API 請求。你可以在 Apidog 中建立請求、傳送請求以觀察回應,並儲存請求以便團隊協作。建立新請求#
若要在 Apidog 中建立請求,你只需要點擊 「+」 → 「New Request」。你可以依照 API 規格,將請求所需的部分填入 Apidog 介面,例如請求方法、URL、請求參數、授權等等。使用此方法,你可以建立 HTTP、GraphQL 和 SOAP 請求。若要了解如何建立 WebSocket 和 gRPC 請求,請參閱相應協定的文件。請求 URL#
若要在 Apidog 中發出請求,你需要指定代表你要連接之 API 端點的 URL。你可以透過 API 執行的每項操作,通常都會與某個端點相關聯,而該端點具有特定的 URL。如果你正在建置 API:URL 通常由基礎位置加上路徑組成。例如,在請求 URL https://api.example.com/user/12 中,https://api.example.com 是基礎 URL,而 /user/12 是端點路徑。
如果你正在使用公開 API:你的 API 提供者會在其開發者文件中提供你需要的 URL。
你可以在 URL 欄位中輸入查詢參數,也可以在 Params 分頁中輸入。如果你的請求使用路徑參數,則可以在 URL 欄位中輸入它們。如果你未指定協定,Apidog 會自動在 URL 開頭加入 http://。
請求方法#
在 Apidog 中,你可以在請求 URL 左側選擇要使用的請求方法。預設方法為 GET。常見 HTTP 方法#
| 方法 | 用途 | 對資料的影響 |
|---|
| GET | 從指定資源擷取資料 | 唯讀,無副作用 |
| POST | 將資料提交至指定資源進行處理 | 建立新資源 |
| PUT | 更新現有資源 | 取代整個資源 |
| PATCH | 對資源套用部分修改 | 更新特定欄位 |
| DELETE | 請求移除資源 | 移除資源 |
在 API 設計中,相同的 URL 可以使用不同方法請求,代表對同一資源執行不同操作。例如,GET /user/{id} 通常會擷取此 id 的使用者資訊,而 PUT /user/{id} 則會更新此 id 的使用者資訊。傳送請求#
在指定請求協定、方法和 URL 後,請加入你要傳送請求的 API 所需的任何其他詳細資訊:參數和主體:提供需要隨請求一起傳送的任何參數、主體資料或請求標頭。
Cookies:你也可以透過選擇 Cookies 分頁,在請求中使用 cookies。
輸入所有請求詳細資訊後,選擇 Send 將請求傳送至 API 伺服器。你可以在回應窗格中查看伺服器的回應。你可以在側邊欄的 History 中查看已傳送的請求,並再次傳送。這對於偵錯以及比較不同時間的回應很有幫助。