v2-course-member-export.yaml 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v2-course-member-export.yaml
  2. get:
  3. summary: '导出课程成员名单为 Excel'
  4. tags:
  5. - course-member-export
  6. operationId: get_api_v2_course_member_export
  7. description: |-
  8. 导出该课程全部 is_current 成员,表头为 nickname、username、role、status、created_at,
  9. 昵称与用户名通过 UserApi 按 user_id 逐条查询。
  10. 直接以 xlsx 附件(course_member.xlsx)写入输出流,不返回 JSON,且不做登录与权限校验。
  11. 实现:`CourseMemberController@export`
  12. parameters:
  13. -
  14. name: course_id
  15. in: query
  16. schema:
  17. type: string
  18. description: 'course uid'
  19. required: true
  20. responses:
  21. 200:
  22. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  23. content:
  24. application/json:
  25. schema:
  26. type: object
  27. properties:
  28. ok:
  29. type: boolean
  30. message:
  31. type: string
  32. data:
  33. type: object
  34. 401:
  35. $ref: '../../main.yaml#/components/responses/Unauthorized'
  36. 422:
  37. $ref: '../../main.yaml#/components/responses/ValidationError'