Base URL: https://backend-refactor-1as7.onrender.com
所有路徑參數需替換為實際值(如 workspace_id),錯誤回應皆包含 error 字段說明原因。
- 路徑:
POST /user/register - 請求 Body:
{ "username": "用戶名稱", "email": "user@example.com", "password": "用戶密碼" } - 回應:
- 200 OK:註冊成功
- 400 Bad Request:格式錯誤或欄位缺失
- 路徑:
POST /user/login - 請求 Body:
{ "email": "user@example.com", "password": "用戶密碼" } - 回應:
- 200 OK:登入成功
- 400 Bad Request:帳號密碼錯誤
- 路徑:
POST /user/forgot-password - 請求 Body:
{ "email": "user@example.com" } - 回應:
- 200 OK:重設郵件已發送
- 400 Bad Request:Email 格式錯誤
- 路徑:
POST /user/<email>/update-password - 請求 Body:
{ "password": "新密碼" } - 回應:
- 200 OK:密碼更新成功
- 400 Bad Request:欄位缺失
- 路徑:
GET /user/<user_id>/workspace/<workspace_id> - 回應:
- 200 OK:綁定成功
- 400 Bad Request:用戶或工作區不存在
- 路徑:
DELETE /user/<user_id>/workspace/<workspace_id> - 回應:
- 200 OK:移除成功
- 400 Bad Request:綁定關係不存在
- 路徑:
GET /user/<user_id> - 回應:
- 200 OK:返回用戶綁定的工作區列表
- 400 Bad Request:用戶不存在
- 路徑:
GET /user/workspaces - 回應:
- 200 OK:返回所有工作區資料
- 路徑:
POST /user/workspaces - 請求 Body:
{ "name": "工作區名稱" } - 回應:
- 200 OK:創建成功
- 400 Bad Request:名稱格式錯誤(僅允許英文、數字、底線)
- 路徑:
GET /user/workspaces/<workspace_id> - 回應:
- 200 OK:返回工作區詳細資料
- 404 Not Found:工作區不存在
- 路徑:
DELETE /user/workspaces/<workspace_id> - 回應:
- 204 No Content:刪除成功
- 404 Not Found:工作區不存在
- 路徑:
PUT /user/workspaces/<workspace_id>/files - 請求 Body:
{ "file": [ { "name": "檔案1", "content": "內容" }, { "name": "檔案2", "content": "內容" } ] } - 回應:
- 204 No Content:新增成功
- 400 Bad Request:檔案格式錯誤
- 路徑:
DELETE /user/workspaces/<workspace_id>/files/<file_name> - 回應:
- 204 No Content:刪除成功
- 404 Not Found:檔案不存在
- 路徑:
GET /user/workspaces/<workspace_id>/analysis/result - 回應:
- 200 OK:返回分析結果
- 404 Not Found:無結果
- 路徑:
POST /workspace/workspaces/<workspace_id>/analysis/keyword - 請求 Body:
{ "keyword": "關鍵字" } - 回應:
- 200 OK:返回關鍵字分析結果
- 404 Not Found:無結果
- 路徑:
POST /workspace/workspaces/<workspace_id>/analysis/keyword/year - 請求 Body:
{ "start": 2000, "end": 2025, "threshold": 1 } - 回應:
- 200 OK:返回年份趨勢分析
- 404 Not Found:無結果
- 路徑:
POST /workspace/workspaces/<workspace_id>/analysis/keyword/occurence - 請求 Body:
{ "threshold": 1 } - 回應:
- 200 OK:返回高頻關鍵字列表
- 路徑:
POST /workspace/workspaces/<workspace_id>/analysis/author/year - 請求 Body:
{ "start": 2000, "end": 2025, "threshold": 1 } - 回應:
- 200 OK:返回活躍作者分析
- 路徑:
POST /workspace/workspaces/<workspace_id>/analysis/reference - 請求 Body:
{ "threshold": 1 } - 回應:
- 200 OK:返回高引用文獻列表
- 路徑:
POST /workspace/workspaces/<workspace_id>/analysis/field - 請求 Body:
{ "field": "領域名稱" } - 回應:
- 200 OK:返回領域相關分析
- 路徑:
POST /workspace/workspaces/<workspace_id>/analysis/field/year - 請求 Body:
{ "start": 2000, "end": 2025, "threshold": 1 } - 回應:
- 200 OK:返回領域發展趨勢
- 路徑:
POST /workspace/workspaces/<workspace_id>/analysis/field/occurence - 請求 Body:
{ "threshold": 1 } - 回應:
- 200 OK:返回高頻領域列表
- 路徑:
POST /workspace/workspaces/<workspace_id>/analysis/institution - 請求 Body:
{ "start": 2000, "end": 2025, "threshold": 1 } - 回應:
- 200 OK:返回機構合作分析
- 路徑:
POST /workspace/workspaces/<workspace_id>/analysis/institution/year - 請求 Body:
{ "start": 2000, "end": 2025, "threshold": 1 } - 回應:
- 200 OK:返回機構年度趨勢
- 路徑:
POST /workspace/workspaces/<workspace_id>/analysis/country/year - 請求 Body:
{ "start": 2000, "end": 2025, "threshold": 1 } - 回應:
- 200 OK:返回國家發表趨勢
- 路徑:
GET /workspace/workspaces/<workspace_id>/analysis/download - 回應:
- 自動下載 JSON 格式分析報告
- 404 Not Found:無結果