此API参考是按资源类型组织的。每种资源类型都有一个或多个数据表示形式和一个或多个方法。
资源类型
Bundle
有关“Bundle”的详细信息，请参见资源表示页面。
| Method | HTTP request | Description |
|---|---|---|
| create | POST /api/dimzou/bundle/ | 创建一本书 / 翻译一本已出版的书。 |
| update | PATCH /api/dimzou/bundle/{id}/ | 更新该本书的属性。 |
| delete | DELETE /api/dimzou/bundle/{id}/ | 删除该本书。 |
| list | GET /api/dimzou/bundle/ | 返回用户的书的列表。 |
| invitation | POST /api/dimzou/bundle/{id}/invitation/ | 返回该本书下该章节的邀请码。 |
| verifyInvitation | GET /api/dimzou/bundle/verify-invitation/{invitation_code}/ | 验证该章节的邀请码。 |
| markShared | POST /api/dimzou/bundle/{id}/mark-shared/ | 标记该reword被分享过。 |
| nodeDetail | GET /api/dimzou/bundle/{id}/node-detail/ | 返回该章节的简要数据。 |
| insertParagraph | POST /api/dimzou/bundle/{id}/insert-paragraph/ | 插入一个段落。 |
| editParagraph | POST /api/dimzou/bundle/{id}/edit/ | 编辑已存在的段落。 |
| uploadCoverImg | POST /api/dimzou/bundle/{id}/upload/ | 上传章节封面图片。 |
| check | POST /api/dimzou/bundle/{id}/check/ | (书的作者或管理员)审批用户提交的段落。 |
| removeParagraph | POST /api/dimzou/bundle/{id}/remove-paragraph/ | 移除该段落 / 删除该段落下的某个版本(reword)。 |
| sortParagraph | POST /api/dimzou/bundle/{id}/sort-paragraph/ | 调整段落序号。 |
| selectReword | POST /api/dimzou/bundle/{id}/select-reword/ | 选择某个审批过的版本(reword)为该段落的当前被选中版本。 |
| setApplyScenes | POST /api/dimzou/bundle/{id}/set-apply-scenes/ | 为该本书设置应用场景。 |
| prePublish | POST /api/dimzou/bundle/{id}/pre-publish/ | 出版书前的验证。 |
| publish | POST /api/dimzou/bundle/{id}/publish/ | 出版该本书。 |
| publishNodeSection | POST /api/dimzou/bundle/{id}/publish-node-section/ | 出版章节下的某个分片(各个分片以标题段落进行切分) 。 |
| newChapter | POST /api/dimzou/bundle/{id}/chapter/ | 为多章节书创建新章节。 |
| updateChapter | POST /api/dimzou/bundle/{id}/update-chapter/ | 更新该章节的属性。 |
| removeChapter | POST /api/dimzou/bundle/{id}/remove-chapter/ | 删除该章节。 |
| restoreChapter | POST /api/dimzou/bundle/{id}/restore-chapter/ | 恢复被删除的章节。 |
| setChapterManuscript | POST /api/dimzou/bundle/{id}/set-chapter-manuscript/ | 设置章节的Manuscript属性。 |
| setChapterVisibility | POST /api/dimzou/bundle/{id}/set-chapter-visibility/ | 设置章节的visibility属性。章节的可见性(visibility)表示是否可以在已出版的多章书籍中看到未出版的章节。 |
| setCoverChapter | POST /api/dimzou/bundle/{id}/set-cover-chapter/ | 设置一个普通章节为封面章节。 |
| setGeneralChapter | POST /api/dimzou/bundle/{id}/set-general-chapter/ | 设置一个封面章节为普通章节。 |
| sortChapter | POST /api/dimzou/bundle/{id}/sort-chapter/ | 重新为该章节排序。 |
| collaborator | POST /api/dimzou/bundle/{id}/collaborator/ | 添加合作者到该章节/ 更新该章节的合作者身份。 |
| removeCollaborator | DELETE /api/dimzou/bundle/{id}/collaborator-delete/ | 删除该章节的合作者。 |
| listCollaborator | GET /api/dimzou/bundle/{id}/collaborator-list/ | 返回该章节的合作者列表。 |
| createCopy | POST /api/dimzou/bundle/{id}/create-copy/ | 创建该本书的副本。 |
| userRelatedBooks | GET /api/dimzou/bundle/user-related-drafts/ | 返回用户参与过的bundle列表。 |
| targetUserRelatedBooks | GET /api/dimzou/bundle/target-user-related-drafts/ | 返回指定用户参与过的bundle列表。 |
| userCreatedBooks | GET /api/dimzou/bundle/user-created-drafts/ | 返回指定用户创建的bundle列表。 |
| mergeBundle | POST /api/dimzou/bundle/{id}/merge-bundle/ | 合并一本单章节的书到一本多章节书中(单章节书作为一个其中一个新章节)。 |
| separateChapter | POST /api/dimzou/bundle/{id}/separate-chapter/ | 分离多章节书中其中一个章节作为一本新的单章节书。 |
| extraInfo | GET /api/dimzou/bundle/extra-info/ | 获取书本的额外信息。 |
Publication
有关“Publication”的详细信息，请参见资源表示页面。
| Method | HTTP request | Description |
|---|---|---|
| get | GET /api/dimzou/publication/ | 返回指定的出版物(Publication)。 |
| history | GET /api/dimzou/publication/{id}/history/ | 出版物全历史版本查询。 |
| related | GET /api/dimzou/publication/{id}/related/ | 返回指定出版物的相关出版物。 |
Category
有关“Category”的详细信息，请参见资源表示页面。
| Method | HTTP request | Description |
|---|---|---|
| create | POST /api/dimzou/category/ | 创建一个分类。 |
| list | GET /api/dimzou/category/my_category_list/ | 返回已经审批通过和用户自己创建的分类列表。 |
Feed
有关“Feed”的详细信息，请参见资源表示页面。
| Method | HTTP request | Description |
|---|---|---|
| mostCommented | GET /api/dimzou/feed/most-commented/ | 返回最多评论的出版物列表。 |
| mostModified | GET /api/dimzou/feed/most-modified/ | 返回最多更改的出版物列表。 |
| mostRead | GET /api/dimzou/feed/most-read/ | 返回最多阅读的出版物列表。 |
| mostTrack | GET /api/dimzou/feed/most-track/ | 返回出版作品最多的用户榜单列表。 |
UserBundleHistory
有关“UserBundleHistory”的详细信息，请参见资源表示页面。
| Method | HTTP request | Description |
|---|---|---|
| commented | GET /api/dimzou/user-bundle-history/commented-bundles/ | 返回用户评论过的bundle列表。 |
| created | GET /api/dimzou/user-bundle-history/created-bundles/ | 返回用户创建的bundle列表。 |
| edited | GET /api/dimzou/user-bundle-history/edited-drafts/ | 返回用户编辑过的bundle列表。 |
| invited | GET /api/dimzou/user-bundle-history/invited-drafts/ | 返回用户被邀请过的bundle列表。 |
| liked | GET /api/dimzou/user-bundle-history/liked-bundles/ | 返回用户点赞过的bundle列表。 |
| read | GET /api/dimzou/user-bundle-history/read-bundles/ | 返回用户阅读过的bundle列表。 |
Collaborator
有关“Collaborator”的详细信息，请参见资源表示页面。
| Method | HTTP request | Description |
|---|---|---|
| list | GET /api/dimzou/collaborators/ | 返回指定章节的合作者列表。 |
Paragraph
有关“Paragraph”的详细信息，请参见资源表示页面。
| Method | HTTP request | Description |
|---|---|---|
| list | GET /api/dimzou/paragraph/ | 返回指定章节下的段落。 |
| range | GET /api/dimzou/paragraph/paragraph-range/ | 返回指定段落往下一定范围的段落列表。 |
| batch | GET /api/dimzou/paragraph/batch/ | 返回指定的段落列表 |
Node
有关“Node”的详细信息，请参见资源表示页面。
Reword
有关“Reword”的详细信息，请参见资源表示页面。
Invitation
有关“Invitation”的详细信息，请参见资源表示页面。
阅读统计
有关阅读统计的接口，请查看 Dimzou: 阅读统计
Enums
Bundle.Type
enum Type {
Origin = 0,
Translation = 100,
}Bundle.Status
enum Status {
Draft = 0,
Published = 200,
}Node.Type
enum Type {
Chapter Node = 0,
Cover Node = 100,
}Node.Status
enum Status {
Draft = 0,
Published = 200,
}Permission
enum Permission {
Public = 0,
Group = 100,
}Paragraph.Type
enum Type {
Title = 0,
Summary = 100,
Block = 200,
Cover = 300,
}Reword.Type
enum Type {
Title = 0,
Summary = 100,
Block = 200,
Cover = 300,
}Reword.Status
enum Status {
Pending = 0,
Accepted = 100,
Rejected = 200,
Deleted = 300,
}Reword.MediaType
enum MediaType {
Text = 0,
Code block = 100,
Math Equation = 200,
Image = 300,
File = 400,
}Collaborator.Role
enum Role {
Owner = 0,
Admin = 100,
Participator = 200,
}Publication.PubType
enum PubType {
Bundle = 0,
Chapter = 100,
Cover = 200,
}