index.yaml 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  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: format
  41. in: query
  42. description: 服务器渲染content的格式。默认react
  43. schema:
  44. type: string
  45. enum:
  46. - react
  47. - unity
  48. - html
  49. - text
  50. - tex
  51. - simple
  52. - name: limit
  53. in: query
  54. description: 每次提取记录数
  55. schema:
  56. type: number
  57. minimum: 1
  58. maximum: 1000
  59. - name: offset
  60. in: query
  61. description: 从第几条记录开始提取
  62. schema:
  63. type: number
  64. responses:
  65. "200": # status code
  66. description: A JSON array of user names
  67. content:
  68. application/json:
  69. schema:
  70. type: object
  71. properties:
  72. ok:
  73. type: boolean
  74. message:
  75. type: string
  76. data:
  77. type: object
  78. properties:
  79. rows:
  80. type: object
  81. $ref: "./data.yaml"
  82. count:
  83. type: number
  84. description: 符合要求的记录总数