| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104 |
- # 由 openapi/scripts/generate.php 生成，请勿手改；补充写到 overrides/v2-vocabulary.yaml
- get:
- summary: '列出 vocabulary'
- tags:
- - vocabulary
- operationId: get_api_v2_vocabulary
- description: 实现：`VocabularyController@index`
- parameters:
- -
- name: view
- in: query
- schema:
- type: string
- enum:
- - key
- -
- name: key
- in: query
- schema:
- type: string
- default: ''
- -
- 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: { word: { type: string }, count: { type: integer }, strlen: { type: string }, meaning: { type: string } }
- count:
- type: integer
- 401:
- $ref: '../../main.yaml#/components/responses/Unauthorized'
- 422:
- $ref: '../../main.yaml#/components/responses/ValidationError'
- post:
- summary: '新建 vocabulary'
- tags:
- - vocabulary
- operationId: post_api_v2_vocabulary
- description: 实现：`VocabularyController@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'
|
