Skip to content

API 文档

本部分用于固化前后端协作契约。接口文档与数据库设计、详细设计共同构成“可直接编码”的实现基线。

阅读顺序

  1. 先读 API 总览,确认统一约定、鉴权和分页规则。
  2. 再按模块阅读认证、平台治理、课程、任务、成绩和通知接口。
  3. 联调和测试时同步查阅 错误码规范

使用规则

  • 所有公开给前端的接口必须在本目录登记。
  • 内部 Worker 与 go-judge 的适配字段不直接暴露给前端,但要在研发文档中说明。
  • 若后续产出 OpenAPI 文件,应以本目录内容为源头而不是绕过本目录单独维护。