index.yaml 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. get:
  2. summary: 句子信息列表
  3. tags:
  4. - sentence
  5. description: 返回多行数据。支持分页。
  6. parameters:
  7. - name: view
  8. in: query
  9. required: true
  10. description: 查询的内容
  11. schema:
  12. type: string
  13. enum:
  14. - chapter
  15. - name: book
  16. in: query
  17. required: true
  18. description: 书号
  19. schema:
  20. type: number
  21. minimum: 1
  22. maximum: 217
  23. - name: para
  24. in: query
  25. required: true
  26. description: 段落号
  27. schema:
  28. type: number
  29. - name: channels
  30. in: query
  31. required: true
  32. description: channel uuid 多个channel 用英文逗号分隔
  33. schema:
  34. type: string
  35. - name: html
  36. in: query
  37. description: 是否由服务器渲染content 默认false
  38. schema:
  39. type: boolean
  40. - name: limit
  41. in: query
  42. description: 每次提取记录数
  43. schema:
  44. type: number
  45. minimum: 1
  46. maximum: 1000
  47. - name: offset
  48. in: query
  49. description: 从第几条记录开始提取
  50. schema:
  51. type: number
  52. responses:
  53. "200": # status code
  54. description: A JSON array of user names
  55. content:
  56. application/json:
  57. schema:
  58. type: object
  59. properties:
  60. ok:
  61. type: boolean
  62. message:
  63. type: string
  64. data:
  65. type: object
  66. properties:
  67. rows:
  68. type: object
  69. $ref: "./data.yaml"
  70. count:
  71. type: number
  72. description: 符合要求的记录总数