index.yaml 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  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. - paragraph
  16. - name: book
  17. in: query
  18. required: true
  19. description: 书号1~217
  20. schema:
  21. type: number
  22. minimum: 1
  23. maximum: 217
  24. - name: para
  25. in: query
  26. required: true
  27. description: 段落号 章节模式只能一个 段落模式可以多个段落,以逗号分隔
  28. schema:
  29. type: string
  30. - name: channels
  31. in: query
  32. required: true
  33. description: channel uuid 多个channel 用英文逗号分隔
  34. schema:
  35. type: string
  36. - name: html
  37. in: query
  38. description: 是否由服务器渲染content 默认false
  39. schema:
  40. type: boolean
  41. - name: format
  42. in: query
  43. description: 服务器渲染content的格式。默认react
  44. schema:
  45. type: string
  46. enum:
  47. - react
  48. - unity
  49. - html
  50. - text
  51. - tex
  52. - simple
  53. - name: limit
  54. in: query
  55. description: 每次提取记录数
  56. schema:
  57. type: number
  58. minimum: 1
  59. maximum: 1000
  60. - name: offset
  61. in: query
  62. description: 从第几条记录开始提取
  63. schema:
  64. type: number
  65. responses:
  66. "200": # status code
  67. description: A JSON array of user names
  68. content:
  69. application/json:
  70. schema:
  71. type: object
  72. properties:
  73. ok:
  74. type: boolean
  75. message:
  76. type: string
  77. data:
  78. type: object
  79. properties:
  80. rows:
  81. type: object
  82. $ref: "./data.yaml"
  83. count:
  84. type: number
  85. description: 符合要求的记录总数