课堂管理系统接口文档
|
353
|
0

0. 综述

  • 软件结构图

  • 接口位置
    https://classmanagement.sunxiaochuan258.com/

  • 接口返回数据基本结构

    {
  "status":"",
  "msg":"",
  "data":""
}

    status每个接口军返回，可能值有success, failed, error。若返回值为success代表操作成功，可在msg或data中获取结果（如果有）；若返回值为failed代表操作失败，可在msg中获取失败信息；若返回值为error代表程序发生错误，可在error中获取错误信息。切勿将错误信息显示在前端，若出现错误，检查是否发生越权（如未注册用户进入系统操作等可能会发生数据库错误，大部分越权现象在后端进行了禁止，但仍需要前后端配合），若确认没有越权，请及时通报。

    msg通常是一个字符串，data可能是字符串或数组。下文不再解释status的可能值及含义。

1. 基本保障模块

1.1 网络连接测试

1.1.1 请求地址

https://classmanagement.sunxiaochuan258.com/test/check_connection

1.1.2 请求方式

GET

1.1.3 请求参数

无

1.1.4 返回值

返回json数据包，链接失败则无返回值：

{
    'status': 'success'
}

2. 教师模块

2.1 发送验证码

2.1.1 请求地址

https://classmanagement.sunxiaochuan258.com/teacher/verify

2.1.2 请求方式

GET

2.1.3 请求参数

属性 类型 说明
email string 邮箱

2.1.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": ""
}
属性 类型 说明
msg string 失败信息

msg的可能值（仅在失败时存在）：

值 含义
missing_param 参数缺失

2.2 教师注册

2.2.1 请求地址

https://classmanagement.sunxiaochuan258.com/teacher/signup

2.2.2 请求方式

GET

2.2.3 请求参数

属性 类型 说明
email string 邮箱
username string 用户名
realname string 真实姓名
pwd string 密码
token string 验证码

均不超过20位。

2.2.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": ""
}
属性 类型 说明
msg string

msg的可能值（仅在失败时存在）：

值 含义
missing_param 参数缺失
wrong_token 验证码错误
account_exist 用户名或邮箱已存在

2.3 获取登录状态

2.3.1 请求地址

https://classmanagement.sunxiaochuan258.com/teacher/check_login

2.3.2 请求方式

GET

2.3.3 请求参数

无

2.3.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": ""
}
属性 类型 说明
msg string 查询结果

msg的可能值：

值 含义
logged_in 已登录
not_logged_in 未登录

可在登录前检查，若检查到已登录则跳过登录直接进入系统。

2.4 教师登录

2.4.1 请求地址

https://classmanagement.sunxiaochuan258.com/teacher/login

2.4.2 请求方式

GET

2.4.3 请求参数

属性 类型 说明
email string 邮箱
pwd string 密码

2.4.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": ""
}
属性 类型 说明
msg string

msg的可能值：

值 含义
missing_param 参数缺失
wrong_pwd 密码错误
account_banned_verification_sent 账号被禁用且已发送验证邮件
account_banned_verification_failed 账号被禁用且验证邮件发送失败
too_many_wrong_pwd_verification_sent 密码错误次数过多，账号被禁用且已发送验证邮件
too_many_wrong_pwd_verification_failed 密码错误次数过多，账号被禁用且验证邮件发送失败

2.5 教师登出

2.5.1 请求地址

https://classmanagement.sunxiaochuan258.com/teacher/logout

2.5.2 请求方式

GET

2.5.3 请求参数

无

2.5.4 返回值

无

2.6 教师账号解封

2.6.1 请求地址

https://classmanagement.sunxiaochuan258.com/teacher/activate

2.6.2 请求方式

GET

2.6.3 请求参数

属性 类型 说明
email string 邮箱
token string 验证码

2.6.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": ""
}
属性 类型 说明
string 失败信息

msg的可能值：

值 含义
missing_param 参数缺失
wrong_token 验证码错误

2.7 获取当前在线教师邮箱

2.7.1 请求地址

https://classmanagement.sunxiaochuan258.com/teacher/get_email

2.7.2 请求方式

GET

2.7.3 请求参数

无

2.7.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": "",
    "data": ""
}
属性 类型 说明
msg string 错误信息
data string 邮箱

msg的可能值：

值 含义
not_logged_in 未登录

2.8 教师账号改密

2.8.1 请求地址

https://classmanagement.sunxiaochuan258.com/teacher/change_pwd

2.8.2 请求方式

GET

2.8.3 请求参数

属性 类型 说明
email string 邮箱
token string 验证码
new_pwd string 新密码

验证码可通过发送验证码接口发送。

2.8.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": ""
}
属性 类型 说明
msg string 失败信息

msg的可能值：

值 含义
missing_param 参数缺失
wrong_token 验证码错误

改密成功后自动退出登录。

2.9 教师姓名修改

2.9.1 请求地址

https://classmanagement.sunxiaochuan258.com/teacher/change_realname

2.9.2 请求方式

GET

2.9.3 请求参数

属性 类型 说明
email string 邮箱
new_realname string 新姓名

2.9.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": ""
}
属性 类型 说明
string 失败信息

status的可能值：

值 含义
missing_param 参数缺失
not_logged_in 未登录

2.10 教师邮箱修改

2.10.1 请求地址

https://classmanagement.sunxiaochuan258.com/teacher/change_email

2.10.2 请求方式

GET

2.10.3 请求参数

属性 类型 说明
email string 旧邮箱
token string 验证码
new_email string 新邮箱

验证码可通过发送验证码接口发送，请发送到新邮箱。

2.10.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": ""
}
属性 类型 说明
string 失败信息

msg的可能值：

值 含义
missing_param 参数缺失
wrong_token 验证码错误

操作成功后自动退出登录。

3. 课程模块

3.1 添加课程

3.1.1 请求地址

https://classmanagement.sunxiaochuan258.com/course/add

3.1.2 请求方式

GET

3.1.3 请求参数

属性 类型 说明
course_id_1 string 课程号
course_id_2 string 验证码
new_email string 课程名
remark string 备注（非必须）

3.1.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": ""
}
属性 类型 说明
string 失败信息

msg的可能值：

值 含义
missing_param 参数缺失
课程已存在
not_logged_in 未登录

3.2 获取课程信息

3.2.1 请求地址

https://classmanagement.sunxiaochuan258.com/course/get/{0}/{1}

当{0}与{1}均为空时，代表获取未归档课程信息；当{0}为all时，不需要{1}，代表获取全部课程信息；其余情况代表获取一门课的信息，{0}为课程号，{1}为课序号。

3.2.2 请求方式

GET

3.2.3 请求参数

无

3.2.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": "",
    "data": []
}
属性 类型 说明
msg string 失败信息
data array 结果数据

msg的可能值：

值 含义
missing_param 参数缺失
not_logged_in 未登录

当获取一门课的信息时，data形如：

{
    "course_id_1": "",
    "course_id_2": "",
    "course_name": "",
    "remark": ""
}

分别代表课程号、课序号、课程名、备注。

其他情况，data为一个数组，每个元素形如：

{
    "course_id_1": "",
    "course_id_2": "",
    "course_name": "",
    "remark": ""
}

分别代表课程号、课序号、课程名、备注。

3.3 获取课程信息

3.3.1 请求地址

https://classmanagement.sunxiaochuan258.com/course/update/{0}/{1}

{0}为课程号，{1}为课序号。

3.3.2 请求方式

GET

3.3.3 请求参数

属性 类型 说明
course_name string 课程名（非必须）
remark string 备注（非必须）

验证码可通过发送验证码接口发送，请发送到新邮箱。

3.3.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": "",
}
属性 类型 说明
msg string 失败信息

msg的可能值：

值 含义
missing_param
not_logged_in 未登录

3.4 归档课程

3.4.1 请求地址

https://classmanagement.sunxiaochuan258.com/course/deactivate/{0}/{1}

{0}为课程号，{1}为课序号。

3.4.2 请求方式

GET

3.4.3 请求参数

无

3.4.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": "",
}
属性 类型 说明
msg string 失败信息

msg的可能值：

值 含义
not_logged_in 未登录

3.5 取消归档课程

3.5.1 请求地址

https://classmanagement.sunxiaochuan258.com/course/activate/{0}/{1}

{0}为课程号，{1}为课序号。

3.5.2 请求方式

GET

3.5.3 请求参数

无

3.5.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": "",
}
属性 类型 说明
msg string 失败信息

msg的可能值：

值 含义
not_logged_in 未登录

3.6 删除课程

3.6.1 请求地址

https://classmanagement.sunxiaochuan258.com/course/delete/{0}/{1}

{0}为课程号，{1}为课序号。

3.6.2 请求方式

GET

3.6.3 请求参数

无

3.6.4 返回值

返回json数据包，形如：

{
    "status": "",
    "msg": "",
}
属性 类型 说明
msg string 失败信息

msg的可能值：

值 含义
not_logged_in 未登录
隐藏
变装