API 参考
API¶
本文按当前代码列出主要 HTTP API。除标注为公开接口外,Node API 路由在 /api 下均要求 Authorization: Bearer <JWT>。登录成功返回 1 小时有效的 token;JSON 字段、错误码等实现细节如有变化,以服务端路由和 handler 为准。
Node 主 API:认证和用户¶
| 方法 | 路径 | 权限 | 用途/参数 |
|---|---|---|---|
| POST | /api/login |
公开 | JSON {email, password};成功返回 {token} |
| POST | /api/user |
公开 | 注册;JSON {email, name, password},密码至少 8 位 |
| GET | /api/user?email=... |
本人或管理员 | 获取用户资料 |
| DELETE | /api/user?email=... |
管理员 | 删除用户 |
| POST | /api/user-password |
本人或管理员 | JSON {email, password},更新密码 |
| POST | /api/user-avatar |
本人或管理员 | JSON {email, avatar},更新头像 |
Node 主 API:书籍¶
| 方法 | 路径 | 权限 | 用途/参数 |
|---|---|---|---|
| GET | /api/novel_list |
已登录 | 获取下载量最高的 10 本书的摘要 |
| POST | /api/search-novel |
已登录 | JSON {keyword};按书名、作者或标签搜索,最多 20 条 |
| GET | /api/novel-detail?book_id=... |
已登录 | 获取书籍详情并记录用户/书籍下载关联 |
| POST | /api/novel |
管理员 | 新增书籍,JSON 字段含 name, detail 及可选元数据 |
| DELETE | /api/novel?id=... |
管理员 | 删除书籍 |
| POST | /api/batch-upload-novel |
管理员 | multipart 多文件上传;限制见批量上传 |
Node 主 API:评论、书架和管理¶
| 方法 | 路径 | 权限 | 用途/参数 |
|---|---|---|---|
| GET | /api/comment?book_id=...&start=1&limit=10 |
已登录 | 分页读取书籍评论 |
| POST | /api/comment |
已登录 | JSON {book_id, detail},作者由当前用户确定 |
| PUT | /api/comment |
评论作者或管理员 | JSON {comment_id, detail} |
| DELETE | /api/comment?id=... |
评论作者或管理员 | 删除评论 |
| GET | /api/user-book?user_id=... |
本人或管理员 | 获取用户书架 |
| POST | /api/user-book |
本人或管理员 | JSON {user_id, book_id},保存书籍 |
| DELETE | /api/user-book?user_id=...&book_id=... |
本人或管理员 | 从书架移除书籍 |
| GET | /api/admin/users?page=1&pageSize=20 |
管理员 | 分页浏览用户 |
| GET | /api/admin/books?page=1&pageSize=20 |
管理员 | 分页浏览书籍 |
| GET | /api/admin/comments?page=1&pageSize=20 |
管理员 | 分页浏览评论 |
| GET | /api/admin/statistics |
管理员 | 汇总计数和评论分布 |
| GET | /api/admin/book-statistics?book_id=... |
管理员 | 单本书及其分页评论统计 |
分页列表默认 pageSize=20,最大 100。没有评分 API。Node 当前也没有 /api/ping 路由;阅读器客户端保留的 checkNet() 不应视为已实现端点。
Python 标签 API¶
独立服务默认监听 127.0.0.1:5000:
| 方法 | 路径 | 请求 | 响应 |
|---|---|---|---|
| POST | /api/tags |
JSON { "text": "..." } |
JSON { "tags": "tag1,tag2" } |
缺少字符串 text 时返回 HTTP 400 和 { "error": "A text string is required" }。服务用于 Node 的定时标签任务。