Skip to content

Latest commit

 

History

History
120 lines (99 loc) · 3.75 KB

后端API接口说明.md

File metadata and controls

120 lines (99 loc) · 3.75 KB

后端 API 接口说明

数据类型

Course

course_name: str # Primary key course_term: str # Secondary key course_id: int course_qr_code_url: str

MissingRecord

course_name: str # Primary key course_term: str # Secondary key total_count: int

SingleEvent

title: str date: str duration: str time_zone: str slots: dict location: str description: str contact: str qr_code: str

EventRegisterInfo

event_id: str # Primary Key email: str # Secondary Key name: str wechat_id: str time_slot: str image: list description: str other_concern: str

API 路径

  1. 测试用 Home Page: 路径: "/" 指令类型: GET 参数: 无 返回结果: Hello World

  2. 获取所有的 Courses 路径: "/courses/get_all_courses/{email}/{access_token}" 指令类型: GET 参数: {email: str, access_token: str} 返回结果:      -若 access token 匹配 则返回所有的 Course 数据      -若不匹配 触发 401 Error Code

  3. 上传一个新的 Course 路径: "/courses/upload_course" 指令类型: POST 参数: {course_obj: Course} 返回结果:      {"message": f"Course {course_obj.course_name} uploaded successfully"}

  4. 核实 Google Email Address 路径: "/email/verify_google_email/{email_address}/{verified_status}/{user_name}" 指令类型: POST 参数: {email_address: str, verified_status: str, user_name: str} 返回结果:      -若认证成功 返回 {"message": f"Email {email_address} verified successfully.", "access_token": access_token}      -若认证失败 触发 400 Error Code

  5. 给邮箱发送验证码 路径: "/email/send_verification_code/{email_address}" 指令类型: POST 参数: {email_address: str} 返回结果:      {"message": f"Verification code sent to {email_address}"}

  6. 核实验证码 路径: "/email/verify_authentication_code/{email_address}/{authentication_code}" 指令类型: POST 参数: {email_address: str, authentication_code: str} 返回结果:      -若邮件地址为管理员邮箱 返回 {"message": f"Admin email {email_address} detected. Welcome.", "access_token": access_token}      -若邮件地址以及验证码与数据库里对应成功 返回 {"message": f"Authentication code verified for {email_address}.", "access_token": access_token}      -若对应失败 触发 400 Error Code

  7. 申请建群/Report Missing Class 路径: "/courses/report_missing_class" 指令类型: POST 参数: {report_obj: MissingRecord} 返回结果: {"message": f"Course missing report for {term} {course_full_name} has been recorded. Now count is {count}."}

  8. 获取活动信息 路径: "/event/get_event_info/{event_id}" 指令类型: GET 参数: {event_id: str} 返回结果:
         -若 Event_id 存在 则返回相应的 Event 数据      -若不存在 触发 400 Error Code

  9. 获取所有活动信息 路径: "/event/get_all_events" 指令类型: GET 参数: 无 返回结果: 返回全部现有的活动信息

  10. 新建一个活动 路径: "/event/create_event" 指令类型: POST 参数: {event_obj: SingleEvent} 返回结果:
         -若活动时间格式正确（为 8 位数） 则返回 {"message": f"Event created successfully"}      -若不正确 触发 400 Error Code

  11. 活动报名 路径: "/event/register" 指令类型: POST 参数: {reg_info_obj: EventRegisterInfo} 返回结果: {"message": f"Register information uploaded successfully"}