RESTful API 设计模板

設計請求 # RESTful API 用途 ## API [描述API的業務用途和目標] ## 資源定義 - [資源1及其屬性] - [資源2及其屬性] - ... ## 操作需求 - [需要支援的CRUD操作及其業務邏輯] - [特殊操作需求] ## 技術要求 - 認證方式: [如OAuth, API Key等] - 回應格式: [如JSON, XML等] - 錯誤處理: [錯誤回應格式要求] ## 期望輸出 - 完整的API端點設計 - 請求/回應範例 - 狀態碼使用說明 - 認證流程說明 - API文件結構