index.yaml 1.8 KB

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