成功傳送 API 請求後,Apidog 可以自動解析請求與回應資料,以建立完整的端點規格。這項強大的功能可節省時間,並確保你的 API 文件能準確反映實際行為。將請求解析為端點規格#
成功傳送的請求若尚未定義,Apidog 可以自動將其解析為端點規格。傳送請求後,你可以點擊 Save 按鈕旁的下拉選單,並選擇 Save as endpoint,將其儲存為端點規格。當你將請求儲存為端點時,Apidog 會智慧擷取以下資訊:請求參數:目前請求的 request params 類型會被視為端點中的請求參數規格,而目前的參數值會被視為請求參數的範例值。
回應 Schema:目前請求的回應資料結構會被解析為回應規格,而回應值會被視為回應範例。
當你處理現有 API,或想根據實際請求/回應資料快速記錄 API,而不是手動定義 schema 時,此功能特別有用。
擷取回應#
Apidog 支援將回應擷取到端點規格中,可擷取為 response schema 或 response examples。這種彈性讓你可以選擇要更新端點的 schema 定義,或只是新增一個回應範例,以供文件與測試使用。當 API 結構已變更時,將回應擷取為 schema 很有用;而擷取為範例則更適合用於記錄不同的回應情境(成功、錯誤、邊界案例)。