Apidog 的 APIs 模組提供兩種模式,可在介面左下角切換:Design-first Mode 與 Request-first Mode。兩種模式提供相似的功能,但介面不同,以滿足不同團隊的工作流程。Design-first Mode 是 Apidog 建議使用的模式,適合採用 API-Design First 方法的團隊。在此模式中,團隊會先制定 API 規格,然後根據 API 規格進行開發與測試。另一方面,Request-first Mode 適合一開始不定義 API 規格的團隊。這些團隊通常專注於後端開發,完成程式碼後,再產出 API 規格,以便開始測試與用戶端工作。如果你需要呼叫他人開發的 API,但沒有文件,也應使用 Request-first Mode。
Design-First Mode#
在 Design-first Mode 中,編輯 API 規格與傳送請求會透過不同分頁進行。使用者在 Edit 分頁中修改 API 規格,並在 Run 分頁中傳送請求。這種分離方式適合採用 API-Design First 方法的團隊,其中 API 架構師與開發者/使用者具有不同角色。API 架構師負責定義 API 規格而不傳送請求,而開發者則專注於 API 開發與測試,不會變更 API 規格。分開的分頁符合這類團隊的使用習慣。在 Edit 分頁中,API 架構師可以指定請求範例,這些範例會自動設定為 Run 分頁中的預設參數值。API 開發者/使用者可以在 Run 分頁中進一步修改參數值與請求主體。Request-First Mode#
Request-first Mode 適合不事先指定 API 的團隊。後端開發者會直接進行 API 開發,並且在開發期間可能需要呼叫 API 進行偵錯。在此模式中,開發者一開始不需要指定 API;相反地,他們可以直接輸入請求,類似於在 Postman 中建 立新請求。在此介面中,開發者可以輕鬆修改參數類型、名稱、值、主體元件等,而不需要分別調整 API 規格與請求參數值。偵錯完成並儲存後,請求會自動被解析為端點規格。參數會被轉換為規格參數與範例值,而請求/回應主體會被解析為 schema,主體值則會被解讀為請求/回應範例。開發者可以根據需求進一步細化並完善此端點規格。模式之間的差異#
這兩種模式之間的主要差異在於,在 Request-first Mode 中,請求主體會被用作端點請求主體範例。相較之下,在 Design-first Mode 中,使用者可以在 Run 分頁中輸入實際的請求主體,以及請求主體範例。因此,Run 分頁中的主體區段僅在 Design-first Mode 中可用,在 Request-first Mode 中不可見。另一個差異是,在 Design-first Mode 中,你可以在端點規格層級或 run/端點案例層級新增前置/後置處理器。而在 Request-first Mode 中,由於沒有 Run 分頁,所有前置/後置處理器都會被視為位於端點規格層級。run/端點案例層級的前置/後置處理器在 Request-first Mode 中不可見。