| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091 |
- # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v2-book-title.yaml
- get:
- summary: '列出 book-title'
- tags:
- - book-title
- operationId: get_api_v2_book_title
- description: 实现:`BookTitleController@index`
- parameters:
- -
- name: search
- in: query
- description: 搜索关键字
- schema:
- type: string
- -
- name: order
- in: query
- description: 排序字段
- schema:
- type: string
- -
- name: dir
- in: query
- description: 排序方向
- schema:
- type: string
- enum:
- - desc
- - asc
- -
- name: limit
- in: query
- description: 每页记录数
- schema:
- type: number
- -
- name: offset
- in: query
- description: 从第几条记录开始提取
- schema:
- type: number
- responses:
- 200:
- description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
- content:
- application/json:
- schema:
- type: object
- properties:
- ok:
- type: boolean
- message:
- type: string
- data:
- type: object
- properties:
- rows:
- type: array
- items:
- type: object
- properties: { book: { type: integer }, paragraph: { type: integer }, sn: { type: integer }, title: { type: string }, toc: { type: string, nullable: true }, tags: { type: array, items: { type: string } }, related_name: { type: string, nullable: true }, language: { type: string, nullable: true, description: 仅在部分查询口径下返回。 } }
- count:
- type: integer
- 401:
- $ref: '../../main.yaml#/components/responses/Unauthorized'
- 422:
- $ref: '../../main.yaml#/components/responses/ValidationError'
- post:
- summary: '新建 book-title'
- tags:
- - book-title
- operationId: post_api_v2_book_title
- description: 实现:`BookTitleController@store`
- responses:
- 200:
- description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
- content:
- application/json:
- schema:
- type: object
- properties:
- ok:
- type: boolean
- message:
- type: string
- data:
- type: object
- 401:
- $ref: '../../main.yaml#/components/responses/Unauthorized'
- 422:
- $ref: '../../main.yaml#/components/responses/ValidationError'
|