v3 重构

[ricky8955555]

目前处于 Draft (草稿) 阶段，在完成工作后将会转为 Ready (就绪) 拉取请求。

[ricky8955555]

API

返回类型

API 统一返回 api/types.py 中定义的 ApiResponse[T] 类型。

定义

路由中 {...} 对应待完善参数，路由具体定义参见 api/ 相应路由的注释。

若请求方法不带请求体，路由后 () 内为返回类型；若请求方法带请求体，则第一个为请求体类型，第二个为返回类型。

类型相关定义参见 api/types.py 及 models/__init__.py。

教务系统相关

• GET /api/eas/courses (list[Course]): 获取公选课课程列表
• GET /api/courses/{id}/lessons (list[Lesson]): 获取公选课的节次详情列表

抢课工具相关

• GET /api/grabber (list[KeyValuePair[int, GrabberTask]]]): 获取抢课任务列表
• POST /api/grabber (GrabberTask, None): 添加抢课任务
• DELETE /api/grabber/{id} (None): 销毁抢课任务
• GET /api/grabber/{id} (GrabberTask): 获取抢课任务
• GET /api/grabber/{id}/reset (None): 重置抢课任务
• GET /api/grabber/{id}/start (bool): 启动抢课任务
• GET /api/grabber/{id}/cancel (bool): 取消抢课任务
• PUT /api/grabber/{id} (GrabberTask, None): 更新抢课任务