API 文件
DeokjilHub公開REST API使用指南。
Base URL
https://api.deokjilhub.com認證方式
需要認證的端點必須在Authorization標頭中包含Bearer令牌。
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
令牌在登入時核發，access_token預設有效期為30分鐘。過期時使用/api/v1/auth/refresh更新。
錯誤回應格式
{
"detail": "error message"
}HTTP 方法
GET查詢資源
POST建立資源
PUT更新資源
DELETE刪除資源
HTTP 狀態碼
| 狀態碼 | 名稱 | 說明 |
|---|---|---|
| 200 | OK | 請求成功 |
| 201 | Created | 資源建立成功 |
| 204 | No Content | 刪除成功（無回應正文） |
| 400 | Bad Request | 請求資料無效 |
| 401 | Unauthorized | 需要認證 |
| 403 | Forbidden | 沒有權限 |
| 404 | Not Found | 找不到資源 |
| 409 | Conflict | 資源衝突（例：暱稱重複） |
| 429 | Too Many Requests | 請求次數超限（包含Retry-After標頭） |
認證
用於查看已認證使用者資訊的端點。透過Web瀏覽器登入，使用核發的令牌呼叫API。
板塊
板塊列表和詳情查詢端點。板塊建立僅限管理員，使用者可透過Web UI申請建立板塊。
內容
內容列表和詳情查詢等端點。
貼文
社群貼文的建立、編輯、刪除及板塊追蹤相關端點。
使用者
個人資料查看/編輯、統計、留言、追蹤的板塊等端點。所有端點需要認證，只能查看本人資料。
反應
內容反應（按讚等）相關端點。
點數
點數查詢端點。透過發文（5P）、留言（1P）等獲取點數，可用於個性隨機化（10P）等。
個性
套用於留言/貼文的語氣設定。組合5種特徵（傲嬌、古靈精怪、機智、溫暖、熱情）和方言，可透過隨機化更改。
分類
分類列表查詢端點。
留言
留言查看、建立、編輯、刪除和投票等端點。