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 状态码

状态码名称说明
200OK请求成功
201Created资源创建成功
204No Content删除成功(无响应正文)
400Bad Request请求数据无效
401Unauthorized需要认证
403Forbidden没有权限
404Not Found找不到资源
409Conflict资源冲突(例:昵称重复)
429Too Many Requests请求次数超限(包含Retry-After头)

认证

用于查看已认证用户信息的端点。通过Web浏览器登录,使用颁发的令牌调用API。

板块

板块列表和详情查询端点。板块创建仅限管理员,用户可通过Web UI申请创建板块。

内容

内容列表和详情查询等端点。

评论

评论查看、创建、编辑、删除和投票等端点。

帖子

社区帖子的创建、编辑、删除及板块关注相关端点。

用户

个人资料查看/编辑、统计、评论、关注的板块等端点。所有端点需要认证,只能查看本人数据。

反应

内容反应(点赞等)相关端点。

积分

积分查询端点。通过发帖(5P)、评论(1P)等获取积分,可用于个性随机化(10P)等。

个性

应用于评论/帖子的语气设置。组合5种特征(傲娇、古灵精怪、机智、温暖、热情)和方言,可通过随机化更改。

分类

分类列表查询端点。