index.yaml 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. get:
  2. summary: 章节信息列表
  3. tags:
  4. - chapter-index
  5. description: 返回多行数据。支持分页。
  6. parameters:
  7. - name: view
  8. in: query
  9. required: true
  10. description: 查询的内容的类型 public(公开的版本风格)
  11. schema:
  12. type: string
  13. enum:
  14. - public
  15. - name: updated_at
  16. in: query
  17. description: 返回在这个时间之后更新(含新建)的channel列表。app知道目前手机离线包里面的channel表的最新一条记录的更新时间。把这个时间传进去就行。例子 2023-09-18T05:39:51.000000Z
  18. schema:
  19. type: string
  20. format: date-time
  21. - name: order
  22. in: query
  23. description: 排序字段
  24. schema:
  25. type: string
  26. - name: dir
  27. in: query
  28. description: 排序方向
  29. schema:
  30. type: string
  31. enum:
  32. - desc
  33. - asc
  34. - name: limit
  35. in: query
  36. description: 每次提取记录数
  37. schema:
  38. type: number
  39. minimum: 1
  40. maximum: 1000
  41. - name: offset
  42. in: query
  43. description: 从第几条记录开始提取
  44. schema:
  45. type: number
  46. responses:
  47. "200": # status code
  48. description: A JSON array of user names
  49. content:
  50. application/json:
  51. schema:
  52. type: object
  53. properties:
  54. ok:
  55. type: boolean
  56. message:
  57. type: string
  58. data:
  59. type: object
  60. properties:
  61. rows:
  62. type: array
  63. items:
  64. type: object
  65. $ref: "./data.yaml"
  66. count:
  67. type: number
  68. description: 符合要求的记录总数