API接口定义
学院
添加学院
基本信息
Path: /api/v1/college/new
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 非必须 | 学院名称,将会模糊搜索 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
获取学院
基本信息
Path: /api/v1/college/list
Method: POST
接口描述: 获取学院,可以根据关键字模糊查询
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 非必须 | 学院名称,将会模糊搜索 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
课程
开课
基本信息
Path: /api/v1/course/open
Method: POST
接口描述: 添加新课头
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
courseCommonId | integer | 必须 | 课程id | ||
courseSchedules | object [] | 非必须 | 上课时间 | item 类型: object | |
├─ dayOfWeek | integer | 非必须 | 每周第几天 | 最大值: 6 最小值: 0 枚举: 0,1,2,3,4,5,6 | |
├─ endHoursId | integer | 必须 | 第几节课结束(包含该节课) | 最大值: 24 最小值: 1 | |
├─ endWeekId | integer | 必须 | 结束周次 | 最小值: 1 | |
├─ startHoursId | integer | 必须 | 第几节课开始(包含该节课) | 最大值: 24 最小值: 1 | |
├─ startWeekId | integer | 必须 | 起始周次 | 最小值: 1 | |
location | string | 必须 | 上课地点 | ||
quota | integer | 必须 | 容量 | ||
semesterId | integer | 必须 | 学期id | ||
teacherId | integer | 必须 | 教师id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
撤课
基本信息
Path: /api/v1/course/select
Method: DELETE
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
courseId | integer | 必须 | 课头id | ||
studentId | integer | 非必须 | 学生id,用于指定为谁选课和撤课(但是仅管理员可为他人选撤课仅管理员) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
更新课头
基本信息
Path: /api/v1/course/spec/{id}
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
路径参数 |
参数名称 | 示例 | 备注 |
---|---|---|
id | 课头ID | |
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
courseSchedules | object [] | 非必须 | 上课时间 | item 类型: object | |
├─ dayOfWeek | integer | 非必须 | 每周第几天 | 最大值: 6 最小值: 0 枚举: 0,1,2,3,4,5,6 | |
├─ endHoursId | integer | 必须 | 第几节课结束(包含该节课) | 最大值: 24 最小值: 1 | |
├─ endWeekId | integer | 必须 | 结束周次 | 最小值: 1 | |
├─ startHoursId | integer | 必须 | 第几节课开始(包含该节课) | 最大值: 24 最小值: 1 | |
├─ startWeekId | integer | 必须 | 起始周次 | 最小值: 1 | |
location | string | 必须 | 上课地点 | ||
quota | integer | 必须 | 容量 | ||
teacherId | integer | 必须 | 教师id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
更新课程
基本信息
Path: /api/v1/course/{id}
Method: PUT
接口描述: 更新课程的公共信息
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
路径参数 |
参数名称 | 示例 | 备注 |
---|---|---|
id | 课程ID | |
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
collegeId | integer | 必须 | 学院id | ||
credits | number | 必须 | 学分 | ||
hours | integer | 必须 | 学时 | ||
name | string | 必须 | 课程名称 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
查询课头详细信息
基本信息
Path: /api/v1/course/spec/{id}
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
路径参数 |
参数名称 | 示例 | 备注 |
---|---|---|
id | 课头ID |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
查询课程安排
基本信息
Path: /api/v1/course/schedules
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
semesterIds | integer [] | 必须 | 学期id为空则获取所有学期的课程安排 | item 类型: integer | |
├─ | 非必须 | ||||
userId | integer | 非必须 | 用户id。可以为教师、学生,为空时获取当前登录用户的 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
添加课程
基本信息
Path: /api/v1/course
Method: POST
接口描述: 添加新课程
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
collegeId | integer | 必须 | 学院id | ||
credits | number | 必须 | 学分 | ||
hours | integer | 必须 | 学时 | ||
name | string | 必须 | 课程名称 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
获取课程列表
基本信息
Path: /api/v1/course/list
Method: POST
接口描述: 可根据课程名关键字、学期、教师名字、学院ID筛选,字符串类参数为模糊搜索,填空代表不筛选对应条件
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
collegesId | integer [] | 非必须 | 包含的学院id | item 类型: integer | |
├─ | 非必须 | ||||
name | string | 非必须 | 课程名称 | ||
onlyLeftQuota | boolean | 非必须 | 仅有余量 | ||
page | integer | 非必须 | 当前页 | ||
semester | integer | 非必须 | 学期id | ||
size | integer | 非必须 | 每页大小 | ||
teacherName | string | 非必须 | 教师名称 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
选课
基本信息
Path: /api/v1/course/select
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
courseId | integer | 必须 | 课头id | ||
studentId | integer | 非必须 | 学生id,用于指定为谁选课和撤课(但是仅管理员可为他人选撤课仅管理员) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
初始化
初始化系统
基本信息
Path: /api/v1/init
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
id | integer | 必须 | 管理员ID | ||
password | string | 必须 | 管理员密码 | ||
realName | string | 必须 | 管理员真实姓名 | 最大长度: 10 最小长度: 2 | |
username | string | 必须 | 管理员用户名 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
检测是否已初始化系统
基本信息
Path: /api/v1/init
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
公共
可否注册
基本信息
Path: /api/v1/register/enable
Method: GET
接口描述: 检测是否注册
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
开放注册
基本信息
Path: /api/v1/register/enable
Method: POST
接口描述: 开放注册
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
enable | boolean | 非必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
注册
基本信息
Path: /api/v1/register
Method: POST
接口描述: 注册
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
collegeId | integer | 必须 | |||
id | integer | 非必须 | |||
password | string | 必须 | |||
realName | string | 必须 | 最大长度: 10 最小长度: 1 | ||
username | string | 必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
登出
基本信息
Path: /api/v1/logout
Method: GET
接口描述: 登出
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
登录
基本信息
Path: /api/v1/login
Method: POST
接口描述: 登录
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
password | string | 必须 | |||
username | string | 必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
学期
创建学期
基本信息
Path: /api/v1/semester
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
term | integer | 必须 | 对应年份第几学期 | 最大值: 4 最小值: 1 | |
year | integer | 必须 | 年份 | 最小值: 1980 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
获取学期
基本信息
Path: /api/v1/semester
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
获取当前学期
基本信息
Path: /api/v1/semester/curr
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
设置当前学期
基本信息
Path: /api/v1/semester/curr
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
id | integer | 必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
用户
删除指定用户
基本信息
Path: /api/v1/user/{id}
Method: DELETE
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
路径参数 |
参数名称 | 示例 | 备注 |
---|---|---|
id | 用户id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
更新任意用户信息
基本信息
Path: /api/v1/user/{id}
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
路径参数 |
参数名称 | 示例 | 备注 |
---|---|---|
id | 用户id | |
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
collegeId | integer | 必须 | 学院id | 最小值: 1 | |
entranceYear | integer | 必须 | 入学/入职年份 | 最小值: 1980 | |
realName | string | 必须 | 真实姓名 | 最大长度: 10 最小长度: 1 | |
role | integer | 非必须 | 角色 | ||
username | string | 必须 | 用户名 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
更新用户信息
基本信息
Path: /api/v1/user
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
collegeId | integer | 必须 | 学院id | 最小值: 1 | |
entranceYear | integer | 必须 | 入学/入职年份 | 最小值: 1980 | |
realName | string | 必须 | 真实姓名 | 最大长度: 10 最小长度: 1 | |
role | integer | 非必须 | 角色 | ||
username | string | 必须 | 用户名 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
更新用户密码
基本信息
Path: /api/v1/user/pwd
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
路径参数 |
参数名称 | 示例 | 备注 |
---|---|---|
id | 用户id | |
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
password | string | 必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
更新用户密码
基本信息
Path: /api/v1/user/{id}/pwd
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
路径参数 |
参数名称 | 示例 | 备注 |
---|---|---|
id | 用户id | |
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
password | string | 必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
添加用户
基本信息
Path: /api/v1/user/new
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
collegeId | integer | 必须 | 学院id | ||
entranceYear | integer | 必须 | 入学/入职年份 | 最小值: 1980 | |
id | integer | 必须 | 用户id | ||
password | string | 必须 | 密码 | ||
realName | string | 必须 | 真实姓名 | 最大长度: 10 最小长度: 1 | |
role | integer | 非必须 | 角色 | ||
username | string | 必须 | 用户名 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
获取任意用户信息
基本信息
Path: /api/v1/user/{id}
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
路径参数 |
参数名称 | 示例 | 备注 |
---|---|---|
id | 用户id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
获取当前登录用户信息
基本信息
Path: /api/v1/user
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |
获取用户列表
基本信息
Path: /api/v1/user/list
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
collegesId | integer [] | 非必须 | item 类型: integer | ||
├─ | 非必须 | ||||
entranceYearFrom | integer | 非必须 | |||
entranceYearTo | integer | 非必须 | |||
id | integer | 非必须 | |||
page | integer | 非必须 | 当前页 | ||
realName | string | 非必须 | |||
roles | integer [] | 非必须 | item 类型: integer | ||
├─ | 非必须 | 角色 | |||
size | integer | 非必须 | 每页大小 | ||
username | string | 非必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | |||
data | boolean | 非必须 | |||
msg | string | 非必须 |