API 設計原則
掌握 REST 和 GraphQL API 設計原則,打造直觀、可擴展且易於維護的 API,讓開發者愛不釋手,並經得起時間考驗。
使用此技能的時機
- 設計新的 REST 或 GraphQL API
- 重構現有 API 以提升可用性
- 為團隊建立 API 設計標準
- 在實作前審查 API 規格
- 在 API 範式之間遷移(例如 REST 到 GraphQL)
- 建立開發者友善的 API 文件
- 針對特定使用案例(行動裝置、第三方整合)最佳化 API
不應使用此技能的時機
- 你只需要特定框架的實作指引
- 你只進行基礎設施工作,不涉及 API 合約
- 你無法變更或對公開介面進行版本控制
指示
- 定義消費者、使用案例與限制。
- 選擇 API 風格並建模資源或類型。
- 指定錯誤處理、版本控制、分頁與驗證策略。
- 透過範例驗證並進行一致性審查。
請參閱 resources/implementation-playbook.md 以取得詳細的模式、檢查清單與範本。
資源
resources/implementation-playbook.md:包含詳細的模式、檢查清單與範本。