此文档仍在更新中...

基础地址

https://forum.hamcq.cn

身份认证

API 使用基于令牌的身份验证机制。

获取 Token

POST /api/token

{
    "identification": "Toby",
    "password": "pass7word"
}

HTTP/1.1 200 OK

{
    "token": "YACub2KLfe8mfmHPcUKtt6t2SMJOGPXnZbqhc3nX",
    "userId": "1"
}

然后，您可以在后续的请求头中，包含此身份验证令牌:

GET /api/forum HTTP/1.1
Authentication: Token YACub2KLfe8mfmHPcUKtt6t2SMJOGPXnZbqhc3nX

开启 2FA 时，将无法完成请求登录，返回：401 not_authenticated

获取主题 - 获取所有的讨论（默认排序规则为 -time）

GET /api/discussions

GET /api/discussions?sort=-commentCount 按照评论数降序

GET /api/discussions/:id 通过 ID 获取讨论

GET /api/discussions?include=user,lastPostedUser,firstPost,tags 返回指定内容

创建主题

POST /api/discussions

用户信息

GET /api/users/:idOrUsername 通过 ID 或者 用户名 获取信息

获取所有组

GET /api/groups

获取标签

GET /api/tags