API 規劃流程指南

在 API 開發過程中，透過與團隊成員的討論與反覆確認需求，可以讓 API 設計更符合產品需求。以下是 API 規劃的詳細步驟：

1. 確認頁面需求：從 Figma 介面設計分析所需 API

• 打開 Figma 設計，檢視當前頁面的功能需求。
• 根據頁面中各項功能的使用情境，初步判斷可能需要哪些 API。
• 與設計和產品成員討論頁面功能細節，確認 API 是否能滿足頁面設計需求。

2. 設計 API：根據介面功能逐步規劃 API

1. 直觀需求的 API

• 例如在註冊頁面中，可以直接推測需要一個「會員註冊 API」來處理註冊請求。

2. 深入分析需求的 API

• 根據功能邏輯推敲額外需求。例如註冊功能可能需要驗證 Email，因此可能需要「驗證 Email API」以及「驗證碼檢查 API」來確認使用者的 Email 是否有效。

3. 其他 UI 元素需求的 API

• 檢視其他元件是否需要 API 資料來源。例如區碼下拉選單可能需要一個「區碼資料 API」來取得選項數據；若選項固定不變，則也可以選擇將數據寫死在前端代碼中。此部分可以與團隊成員進一步討論決策。

3. 確認最終 API 列表

• 針對每一項需求確認所需 API，形成最終的 API 規劃列表：
  • 註冊 API：用於處理會員註冊請求。
  • 驗證 Email API：用於驗證 Email 的有效性，以及寄送驗證信。
  • 驗證碼檢查 API：用於檢查 Email 驗證碼的正確性。
  • 區碼資料 API：用於提供國家/地區區碼的數據。

4. 在 Github Issue 中建立 API 規劃 (選擇性操作)

使用 GitHub Issues 來追蹤 API 規劃狀況，可以更有效地分配與管理任務。以下是操作步驟：

1. 開啟 API 開發的 GitHub 專案倉庫。

2. 建立新的 Issue。

3. 在 Issue 標題中填入 API 名稱，例如：註冊頁 API - 會員註冊。

4. 在 Issue 描述中詳細說明 API 的用途、需求、參數、回傳格式等細節，並補充相關的需求分析。

5. 將 Issue 指派給負責的開發人員，或分配給特定團隊成員。

6. 添加適當的標籤，例如「enhancement」，或依照團隊需求自訂標籤。

7. 提交 Issue，並於開發過程中根據需要隨時更新內容。

建議

建立初期的 API 規劃後，可以定期回顧與調整，以確保每個 API 能隨著需求演變而逐步完善。與團隊成員保持良好的溝通，適時調整 Issue 中的細節，以便大家更清楚了解 API 設計的最新狀態。