wdh-home
1e33640629
Some checks failed
CI / init (pull_request) Has been cancelled
CI / Frontend node 18.16.0 (pull_request) Has been cancelled
CI / Backend go (1.22) (pull_request) Has been cancelled
CI / release-pr (pull_request) Has been cancelled
CI / devops-test (1.22, 18.16.0) (pull_request) Has been cancelled
CI / release-please (pull_request) Has been cancelled
CI / devops-prod (1.22, 18.x) (pull_request) Has been cancelled
CI / docker (pull_request) Has been cancelled
30 lines
1.2 KiB
Markdown
30 lines
1.2 KiB
Markdown
# 书籍系列 admin 接口
|
||
|
||
## 基本信息
|
||
|
||
- 模块：book
|
||
- 资源：系列
|
||
- 端：admin
|
||
- 鉴权：挂载 `PrivateGroup`，需要 `JWT + Casbin`
|
||
- 操作审计：创建、更新、单删、批量删除写操作启用 `OperationRecord`
|
||
- 路由前缀：`/book`
|
||
|
||
## 默认 CRUD
|
||
|
||
| 动作 | Method | 路径 | API 方法 | Service 方法 |
|
||
|:---|:---|:---|:---|:---|
|
||
| 创建 | `POST` | `/book/createBookSeries` | `CreateBookSeries` | `CreateBookSeries` |
|
||
| 单删 | `DELETE` | `/book/deleteBookSeries` | `DeleteBookSeries` | `DeleteBookSeries` |
|
||
| 批量删除 | `DELETE` | `/book/deleteBookSeriesByIds` | `DeleteBookSeriesByIds` | `DeleteBookSeriesByIds` |
|
||
| 更新 | `PUT` | `/book/updateBookSeries` | `UpdateBookSeries` | `UpdateBookSeries` |
|
||
| 详情 | `GET` | `/book/findBookSeries` | `FindBookSeries` | `GetBookSeries` |
|
||
| 分页列表 | `GET` | `/book/getBookSeriesList` | `GetBookSeriesList` | `GetBookSeriesInfoList` |
|
||
|
||
## 参数与返回
|
||
|
||
- 创建、更新：`body` 使用 `book.BookSeries`。
|
||
- 单删、详情：`query id`。
|
||
- 批量删除：`query ids[]`。
|
||
- 分页列表：`query` 使用 `bookReq.BookSeriesSearch`，返回 `response.PageResult`。
|
||
- 详情返回：`bookRes.BookSeriesResponse`。
|