index.yaml 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. get:
  2. summary: 返回已有译文的章节信息
  3. tags:
  4. - progress
  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: tags
  16. in: query
  17. required: false
  18. description: 标签过滤。空为全部标签。
  19. schema:
  20. type: string
  21. - name: studio
  22. in: query
  23. required: false
  24. description: studio选择。默认选择全部studio
  25. schema:
  26. type: string
  27. - name: progress
  28. in: query
  29. required: false
  30. description: 完成度过滤,默认值0.8
  31. schema:
  32. type: number
  33. minimum: 0
  34. maximum: 1
  35. - name: lang
  36. in: query
  37. required: true
  38. description: 语言过滤 如zh
  39. schema:
  40. type: string
  41. - name: channel
  42. in: query
  43. required: false
  44. description: channel名称过滤
  45. schema:
  46. type: string
  47. - name: channel_type
  48. in: query
  49. required: false
  50. description: channel类型过滤 默认值 translation
  51. schema:
  52. type: string
  53. enum:
  54. - translation
  55. - nissaya
  56. - original
  57. - commentary
  58. - name: limit
  59. in: query
  60. description: 每次提取记录数,默认20
  61. schema:
  62. type: number
  63. minimum: 1
  64. maximum: 1000
  65. - name: offset
  66. in: query
  67. description: 从第几条记录开始提取,默认值0
  68. schema:
  69. type: number
  70. responses:
  71. "200": # status code
  72. description: A JSON array of user names
  73. content:
  74. application/json:
  75. schema:
  76. type: object
  77. properties:
  78. ok:
  79. type: boolean
  80. message:
  81. type: string
  82. data:
  83. type: object
  84. $ref: "./data.yaml"