mirror of
https://github.com/hectorqin/reader.git
synced 2026-11-12 05:50:54 +08:00
CodeBuddy
02453c93d3
记录本轮的四项决定与三个坑： - 排版策略：出版方优先、变量层可被书拒绝、无 !important - 渲染分工按内存而非速度划分 - 外壳用 Shadow DOM、书用 iframe 的完整理由 - column-fill 需要确定高度的实测结论 - 分窗与目录分离的原因 - 解析器版本机制与它解决的静默陈旧问题 - 子资源 query token 的白名单边界
418 lines
14 KiB
Markdown
418 lines
14 KiB
Markdown
# API 参考
|
||
|
||
基础路径 `/api/v1`。除标注「公开」外都需要 `Authorization: Bearer <accessToken>`。
|
||
|
||
错误响应统一格式：
|
||
|
||
```json
|
||
{ "error": { "code": "BOOK_NOT_FOUND", "message": "book not found" } }
|
||
```
|
||
|
||
## 兼容性承诺
|
||
|
||
只做加法。已有字段的语义不会改，端点不会删。
|
||
客户端可以按 `apiVersion` 判断能力，但不需要为小版本做分支。
|
||
|
||
---
|
||
|
||
## 实例信息
|
||
|
||
### `GET /instance` — 公开
|
||
|
||
```json
|
||
{ "name": "reader", "apiVersion": 1, "registrationOpen": false, "userCount": 3 }
|
||
```
|
||
|
||
客户端用它区分「全新实例」（可以注册）和「已被占用」（需要管理员开账号）。
|
||
|
||
### `GET /health` — 公开
|
||
|
||
```json
|
||
{ "status": "ok", "booksDir": "/books", "dataDir": "/data",
|
||
"version": "0.1.0", "dataDirIsInsideBooks": false }
|
||
```
|
||
|
||
`dataDirIsInsideBooks` 恒为 `false`——为 `true` 时服务端根本不会启动。
|
||
暴露出来是为了让运维一眼确认挂载点就是自己以为的那个。
|
||
|
||
---
|
||
|
||
## 认证
|
||
|
||
### `POST /auth/register` — 公开
|
||
|
||
```json
|
||
{ "username": "owner", "password": "至少8位", "displayName": "图书馆长" }
|
||
```
|
||
|
||
- 首个账号恒可注册，且自动成为 `admin`
|
||
- 之后仅在 `ALLOW_REGISTRATION=true` 时开放
|
||
- 关闭时返回 `400 REGISTRATION_DISABLED`
|
||
|
||
返回 `201`：
|
||
|
||
```json
|
||
{ "user": { "id": "...", "username": "owner", "displayName": "图书馆长",
|
||
"role": "admin", "createdAt": 1789537801289 },
|
||
"session": { "user": {...}, "accessToken": "...", "accessTokenExpiresAt": 1789624201289,
|
||
"refreshToken": "...", "refreshTokenExpiresAt": 1821073801289 } }
|
||
```
|
||
|
||
### `POST /auth/login` — 公开
|
||
|
||
`{ "username": "...", "password": "..." }` → 同上（不含 `user` 外包一层）
|
||
|
||
失败恒为 `401 BAD_CREDENTIALS`，不区分「用户不存在」和「密码错误」。
|
||
账号停用返回 `403 ACCOUNT_DISABLED`。
|
||
|
||
### `POST /auth/refresh` — 公开
|
||
|
||
`{ "refreshToken": "..." }` → 新的 `session`。
|
||
|
||
**刷新令牌会轮转**：传入的那个立即作废。客户端必须持久化新的那个。
|
||
|
||
### `POST /auth/logout`
|
||
|
||
`{ "refreshToken": "..." }` → `{ "ok": true }`。幂等，重复调用不报错。
|
||
|
||
### `GET /auth/me`
|
||
|
||
→ `{ "user": { ... } }`
|
||
|
||
### `POST /auth/password`
|
||
|
||
`{ "currentPassword": "...", "newPassword": "..." }` → `{ "ok": true }`
|
||
|
||
会撤销该账号**所有**会话（含当前设备），需要重新登录。
|
||
|
||
---
|
||
|
||
## 书架
|
||
|
||
### `GET /books`
|
||
|
||
查询参数：
|
||
|
||
| 参数 | 说明 |
|
||
| --- | --- |
|
||
| `search` | 匹配书名 / 作者 / 系列 / ISBN |
|
||
| `author` `series` `tag` `format` | 精确过滤 |
|
||
| `sort` | `title` \| `author` \| `added` \| `updated`，默认 `added` |
|
||
| `order` | `asc` \| `desc`，默认 `desc` |
|
||
| `page` `pageSize` | 默认 1 / 50，`pageSize` 上限 200 |
|
||
|
||
```json
|
||
{ "items": [ { "id": "...", "title": "三体", "author": "刘慈欣",
|
||
"series": "地球往事", "seriesIndex": 1, "tags": ["科幻"],
|
||
"format": "epub", "coverUrl": "/api/v1/books/<id>/cover",
|
||
"fileSize": 1843, "source": "embedded", "manualFields": [] } ],
|
||
"total": 1, "page": 1, "pageSize": 50 }
|
||
```
|
||
|
||
只看得到「有可用文件」的书。文件被删的书不会留在书架上。
|
||
|
||
`source` 是基础元数据的来源，`manualFields` 列出被手动改过的字段。
|
||
|
||
### `GET /books/:id`
|
||
|
||
→ `{ "book": {...}, "progress": {...} | null }`
|
||
|
||
### `GET /books/:id/manifest`
|
||
|
||
渲染器布局前需要的清单：
|
||
|
||
```json
|
||
{ "book": {...}, "contentUrl": "/api/v1/books/<id>/content",
|
||
"coverUrl": "...",
|
||
"files": [ { "rel_path": "小说/三体.epub", "size": 1843, "missing": 0 } ] }
|
||
```
|
||
|
||
`files` 让客户端能区分「另一份副本」和「文件真的没了」。
|
||
|
||
### `GET /books/:id/items?group=N`
|
||
|
||
书里有哪些**可寻址的单元**：章节、页、卷。这是客户端构建目录和分页的地方。
|
||
|
||
契约对所有格式一致，`kind` 字段告诉客户端该按什么方式渲染：
|
||
|
||
| `kind` | 含义 | 典型格式 |
|
||
| --- | --- | --- |
|
||
| `reflowable` | 可重排文本，按章节加载 | epub |
|
||
| `paged` | 固定页序的图片 | cbz、漫画目录、单图 |
|
||
| `text` | 连续文本，可能带章节 | txt |
|
||
| `document` | 不透明文档，客户端自己渲染 | pdf |
|
||
| `single-image` | 单页图片 | 单个图片文件 |
|
||
|
||
**章节按包内路径寻址，不按下标。** `items[].href` 是不透明的格式私有引用
|
||
（`xhtml:OEBPS/ch1.xhtml`、`page:17`、`chapter:4`），客户端原样回传即可。
|
||
下标只在一个窗口内成立：分窗返回的是 spine 的前缀，所以按下标算出的章节
|
||
在完整 spine 里指向另一章。
|
||
|
||
```json
|
||
{ "kind": "paged", "total": 6,
|
||
"groups": [ { "id": "v0", "seq": 0, "title": "第01卷", "count": 3 },
|
||
{ "id": "v1", "seq": 1, "title": "第02卷", "count": 3 } ],
|
||
"items": [ { "id": "0:0", "seq": 0, "title": "001.jpg", "kind": "page",
|
||
"mediaType": "image/jpeg", "href": "page:0:0" } ] }
|
||
```
|
||
|
||
`groups` 是卷（漫画）或单一隐式分组（epub/txt）。`?group=N` 只返回第 N 组，
|
||
让客户端一次只取一卷而不是整个系列的几千页清单。
|
||
|
||
`total` 在格式无法廉价得知时为 `0`，`groups` 为空 —— 例如没有标题的纯文本。
|
||
不要把它当作错误。
|
||
|
||
### `GET /books/:id/toc`
|
||
|
||
书的目录。**与 `/items` 分开**，因为两者要的性质相反：`/items` 是传输边界，
|
||
一次给一点；目录必须完整，否则跳转是残的。合成一个接口会让目录显示成
|
||
「第 1 章 – 第 40 章」——服务端的分页边界漏进 UI。
|
||
|
||
```json
|
||
{ "toc": [ { "href": "xhtml:OEBPS/text/ch1.xhtml", "title": "第一章", "level": 0, "spine": 0 } ] }
|
||
```
|
||
|
||
`spine` 是全书下标，`/items?group=N` 的每个 group 都带 `offset`，所以客户端
|
||
拿到单窗也能把跳转落到正确章节，不需要把前面的 count 加一遍。
|
||
|
||
按格式：epub 取 spine 标题（NCX / nav），txt 取分章结果，漫画目录取卷，
|
||
pdf / 单图没有独立目录，回落到 items。
|
||
|
||
### `GET /books/:id/assets?ref=<ref>`
|
||
|
||
取单个资源。`ref` 是**不透明**的格式私有引用，客户端只应把它从 `items[].href`
|
||
原样回传，不要自己拼。
|
||
|
||
| 格式 | ref 形态 |
|
||
| --- | --- |
|
||
| epub | `chapter:2`（第 3 章）、或包内资源路径 `OEBPS/images/pic.png` |
|
||
| cbz | `page:17` |
|
||
| 漫画目录 | `page:1:2`（第 2 卷的第 3 页） |
|
||
| txt | `chapter:4` 或 `chunk:262144`（字节偏移） |
|
||
| pdf | `document` |
|
||
|
||
响应带 `Cache-Control: private, max-age=31536000, immutable`：资源由书籍主键寻址，
|
||
而主键来自内容哈希，所以同一个 URL 的内容永不改变。
|
||
|
||
**流式下发，支持 Range。** 响应带 `Accept-Ranges: bytes` 时可以用
|
||
`Range: bytes=0-1023` 取片段（PDF 跳页、漫画跳卷、断点续传）。压缩方式为
|
||
`deflate` 的 zip 条目无法字节定位，会诚实上报 `Accept-Ranges: none` ——
|
||
让客户端知道，而不是白跑一次再发现。
|
||
|
||
**子资源可以带 `?access_token=`。** 章节里的 `<img src>`、`<link href>` 是浏览器
|
||
自己发起的，没法带 `Authorization` 头。这类请求允许把令牌放进 query，
|
||
但**仅限** `GET` + 下列端点：
|
||
|
||
- `/api/v1/books/:id/assets`
|
||
- `/api/v1/books/:id/cover`
|
||
- `/api/v1/books/:id/content`
|
||
|
||
其他任何端点（含触发扫描、写元数据）都不接受 URL 里的令牌 —— URL 会进日志、
|
||
进历史、进 `Referer`，能改状态的令牌不该走那条路。
|
||
|
||
**epub 章节返回的是重写过的 HTML。** 章节内的相对资源引用（`images/pic.png`）已经被
|
||
服务端改写成指向本端点的绝对地址。客户端直接把 HTML 交给 WebView 即可，不需要自己
|
||
解析路径。绝对 URL、`data:` URI 和文内锚点（`#note7`）保持原样，所以脚注和外链仍然可用。
|
||
|
||
### `GET /library/formats`
|
||
|
||
本实例支持的格式清单，由格式注册表生成：
|
||
|
||
```json
|
||
{ "formats": [ { "format": "epub", "kind": "reflowable", "label": "EPUB（精排渲染，保留出版方样式）",
|
||
"extensions": ["epub"], "directory": false } ] }
|
||
```
|
||
|
||
客户端用它决定显示哪些入口，不必硬编码格式列表。
|
||
|
||
### `GET /books/:id/content`
|
||
|
||
流式返回书文件，`Content-Type` 按格式给 `application/epub+zip` 或 `application/pdf`。
|
||
|
||
书内容按哈希不可变，所以带 `ETag`，客户端可以放心长缓存。支持
|
||
`Range: bytes=`，所以**离线下载可以续传**。
|
||
|
||
目录型书籍（漫画目录）没有单一文件，返回 `400 DIRECTORY_BOOK`；
|
||
这类书按 `items?group=N` 逐卷取图。
|
||
|
||
### `GET /books/:id/cover`
|
||
|
||
返回封面。无封面时 `404 NO_COVER`。缓存头是 `immutable`（封面随书籍主键变化）。
|
||
|
||
### `PATCH /books/:id/metadata`
|
||
|
||
```json
|
||
{ "title": "三体（修订版）", "tags": "科幻,雨果奖", "seriesIndex": 1 }
|
||
```
|
||
|
||
可改字段：`title` `author` `publisher` `language` `isbn` `description` `series`
|
||
`seriesIndex` `pubdate` `tags`（`tags` 用逗号分隔的字符串）。
|
||
|
||
写入的是覆盖层，**扫描永远不会覆盖它**。
|
||
|
||
### `DELETE /books/:id/metadata/:field`
|
||
|
||
撤销单个字段，回落到内嵌值。可用来实现 UI 上的「还原」按钮。
|
||
|
||
---
|
||
|
||
## 书库
|
||
|
||
### `GET /library/facets`
|
||
|
||
→ `{ "authors": [...], "series": [...], "tags": [...], "formats": [...] }`
|
||
用来构建筛选界面。
|
||
|
||
### `GET /library/continue?limit=20`
|
||
|
||
继续阅读列表，按最近阅读时间倒序。带 `percentage` 和 `chapterTitle`。
|
||
|
||
### `GET /library/stats`
|
||
|
||
→ `{ "myBooks": 3, "libraryBooks": 10, "files": 12, "missingFiles": 1,
|
||
"formats": [{"format":"epub","n":9}], "scan": {...} }`
|
||
|
||
### `POST /library/scan` — 管理员
|
||
|
||
触发一次扫描，同步等待结果。并发调用会共享同一次扫描。
|
||
|
||
### `GET /library/scan`
|
||
|
||
→ `{ "progress": { "running": false, "scanned": 12, "added": 1, ... } }`
|
||
|
||
---
|
||
|
||
## 同步
|
||
|
||
### `GET /sync?since=<ms>&bookId=<可选>`
|
||
|
||
`since` 是上次响应里的 `serverTime`（首次传 0）。
|
||
|
||
```json
|
||
{ "serverTime": 1789537864820,
|
||
"progress": [ { "bookId": "...", "locator": "epubcfi(/6/4!/4/2)", "percentage": 0.42,
|
||
"chapterTitle": "第七章", "device": "android-a", "updatedAt": 1000 } ],
|
||
"notes": [ { "id": "...", "bookId": "...", "type": "highlight", "locator": "...",
|
||
"text": "...", "comment": "...", "color": "yellow",
|
||
"updatedAt": 1789537864623, "deleted": false } ] }
|
||
```
|
||
|
||
**客户端必须保存返回的 `serverTime`**，下次带回来才能只拿增量。
|
||
|
||
### `POST /sync`
|
||
|
||
```json
|
||
{ "progress": [ { "bookId": "...", "locator": "...", "percentage": 0.42,
|
||
"chapterTitle": "第七章", "device": "android-a", "updatedAt": 1000 } ],
|
||
"notes": [ { "id": "...", "bookId": "...", "type": "highlight", "locator": "...",
|
||
"text": "...", "comment": "...", "color": "yellow",
|
||
"updatedAt": 1000, "deleted": false } ] }
|
||
```
|
||
|
||
两个数组至少给一个，总数上限 5000（超了返回 `400 BATCH_TOO_LARGE`）。
|
||
|
||
`updatedAt` 是**客户端时钟**的毫秒时间戳，决定 LWW 谁赢。
|
||
|
||
响应把合并后的当前状态一并返回，客户端不用再多发一次拉取：
|
||
|
||
```json
|
||
{ "accepted": 1, "rejected": 0, "serverTime": 1789537864820,
|
||
"progress": [...], "notes": [...] }
|
||
```
|
||
|
||
注意：`notes[].type` 只接受 `note` / `highlight` / `bookmark`。
|
||
`notes[].deleted: true` 是删除（写墓碑）。
|
||
|
||
### `GET /sync/progress/:bookId`
|
||
|
||
→ `{ "progress": {...} | null }`
|
||
|
||
### `PUT /sync/progress/:bookId`
|
||
|
||
单个进度上报的便捷写法：
|
||
|
||
```json
|
||
{ "locator": "epubcfi(/6/4!/4/2)", "percentage": 0.42,
|
||
"chapterTitle": "第七章", "device": "android-a", "updatedAt": 1789537864623 }
|
||
```
|
||
|
||
`percentage` 会被夹到 `[0, 1]`。
|
||
|
||
### `GET /notes?bookId=<可选>&since=<可选>`
|
||
|
||
已过滤掉墓碑，只返回可见笔记。
|
||
|
||
### `POST /notes`
|
||
|
||
```json
|
||
{ "bookId": "...", "type": "highlight", "locator": "...",
|
||
"text": "选中的原文", "comment": "我的批注", "color": "yellow" }
|
||
```
|
||
|
||
`id` 可省略或由客户端生成（推荐，便于离线创建）。返回 `201`。
|
||
|
||
### `DELETE /notes/:id`
|
||
|
||
写墓碑。幂等：不存在也返回 `{ "ok": true }`。
|
||
|
||
---
|
||
|
||
## 管理员
|
||
|
||
### `GET /admin/users`
|
||
|
||
→ `{ "users": [ { "id": "...", "username": "...", "displayName": "...",
|
||
"role": "member", "createdAt": 0 } ] }`
|
||
|
||
### `POST /admin/users`
|
||
|
||
```json
|
||
{ "username": "family", "password": "familypass123",
|
||
"displayName": "家人", "role": "member" }
|
||
```
|
||
|
||
不受 `ALLOW_REGISTRATION` 限制——管理员本就该能加家庭成员。
|
||
|
||
### `PATCH /admin/users/:id`
|
||
|
||
`{ "disabled": true }` 或 `{ "role": "admin" }`。
|
||
|
||
不能停用自己（`400 SELF_LOCKOUT`），否则会把自己锁在外面。
|
||
|
||
### `GET /providers`
|
||
|
||
→ `{ "providers": [ { "id": "none", "displayName": "...", "enabled": true } ] }`
|
||
|
||
第一版只有 `none`。在线源接入后会自动出现在这里。
|
||
|
||
---
|
||
|
||
## 错误码
|
||
|
||
| 码 | HTTP | 含义 |
|
||
| --- | --- | --- |
|
||
| `BAD_REQUEST` | 400 | 参数不合法 |
|
||
| `BAD_PAYLOAD` | 400 | 请求体结构错误 |
|
||
| `BATCH_TOO_LARGE` | 400 | 同步批次超过 5000 |
|
||
| `REGISTRATION_DISABLED` | 400 | 实例已关闭公开注册 |
|
||
| `SELF_LOCKOUT` | 400 | 不能停用自己 |
|
||
| `NO_TOKEN` | 401 | 缺少 Bearer 令牌 |
|
||
| `TOKEN_INVALID` | 401 | 签名错误 / 载荷被改 / 类型不对 |
|
||
| `TOKEN_EXPIRED` | 401 | 访问令牌过期，用 refresh 换新 |
|
||
| `REFRESH_INVALID` | 401 | 刷新令牌无效 / 已使用 |
|
||
| `REFRESH_EXPIRED` | 401 | 刷新令牌过期，需要重新登录 |
|
||
| `BAD_CREDENTIALS` | 401 | 用户名或口令错误 |
|
||
| `ACCOUNT_DISABLED` | 403 | 账号被停用 |
|
||
| `FORBIDDEN` | 403 | 越权访问 |
|
||
| `PATH_TRAVERSAL` | 403 | 路径逃逸出挂载点 |
|
||
| `DIRECTORY_BOOK` | 400 | 这本书由目录承载，按页取而不是整本下载 |
|
||
| `UNSUPPORTED_FORMAT` | 400 | 该格式不提供可寻址结构 |
|
||
| `EMPTY_ASSET` | 400 | 资源既没有数据也没有流 |
|
||
| `ADMIN_REQUIRED` | 403 | 需要管理员权限 |
|
||
| `NOT_FOUND` | 404 | 资源不存在 |
|
||
| `NO_COVER` | 404 | 这本书没有封面 |
|
||
| `FILE_MISSING` | 404 | 文件已从磁盘消失 |
|
||
| `USERNAME_TAKEN` | 409 | 用户名已占用 |
|
||
| `PASSWORD_TOO_SHORT` | 409 | 口令少于 8 位 |
|
||
| `INTERNAL` | 500 | 服务端错误 |
|