计算机网路实验课网站接口文档

一、账号操作

1，登录

请求路径：/login
请求方法：POST
权限要求：无
请求参数：json

字段	是否必填
id	Y
password	Y

参数示例：
{
“id”:“1001”,
“password”:“1001”
}

2，注册

一般只能注册学生账号，但数据中没有管理员时也可以注册管理员账户
请求路径：/register
请求方法：POST
权限要求：无
请求参数：json

字段	是否必填
id	Y
name	Y
password	Y

参数示例：
{
“id”:“1003”,
“name”:“1003”,
“password”:“1003”
}

3，注销

请求路径：/logout
请求方法：GET
权限要求：需登录
请求参数：无

4，修改密码

注意修改密码后即使新密码和旧密码一样也需要重新登录，因为原来的token不可用了。

请求路径：/changePassword
请求方法：POST
权限要求：需登录
请求参数：json

字段	是否必填
oldPassword	Y
password	Y

参数示例：
{
“oldPassword”:“1003”,
“password”:“1003”
}

5，修改姓名

请求路径：/changeName
请求方法：POST
权限要求：需登录
请求参数：json

字段	是否必填
name	Y

参数示例：
管理员

6，删除用户

请求路径：/deleteUser
请求方法：POST
权限要求：需登录
请求参数：json

字段名	是否必填
id	Y

参数示例：
1001

7，注册管理员账号

请求路径：/registerAdmin
请求方法：POST
权限要求：admin
请求参数：json

字段名	是否必填
id	Y
name	N
password	Y

参数示例：
{
“id”:“101”,
“name”:“101”
“password”:“101”
}

8，批量注册

请求路径：/batchRegister
请求方法：POST
权限要求：admin
请求参数：json

字段名	是否必填
start	Y
end	Y

参数示例：
{
“start”:“14090031000”,
“end”:“14090031010”
}

9，获取所有用户信息

请求路径：/getUsers
请求方法：Get
权限要求：admin
请求参数：无

10，获取所有管理员信息

请求路径：/getAdmins
请求方法：Get
权限要求：admin
请求参数：无

11，获取所有学生信息

请求路径：/getStudents
请求方法：Get
权限要求：admin
请求参数：无

二、作业操作

管理员接口

1，发布作业

请求路径：/addTask
请求方法：POST
权限要求：admin
请求参数：json

字段名	是否必填
taskName	Y

参数示例：
作业一

2，删除作业

如果改作业没人认提交过作业，会删除文件夹和数据库信息；
如果有人提交过作业，会在数据库中将作业设为隐藏状态
请求路径：/deleteTask
请求方法：POST
权限要求：admin
请求参数：json

字段名	是否必填
taskId	Y

参数示例：
1

3，查看全部作业及提交情况

请求路径：/getTasks
请求方法：GET
权限要求：admin
请求参数：无
返回参数:
count:已提交的数量
{
“role”: “admin”,
“data”: [
{
“count”: 3,
“name”: “作业一”,
“id”: 1,
“status”: 1
},
{
“count”: 2,
“name”: “作业二”,
“id”: 2,
“status”: 1
},
{
“count”: 0,
“name”: “作业三”,
“id”: 3,
“status”: 1
}
],
“errorCode”: 0,
“errorMsg”: “操作成功”
}

4，下载单个学生的单个作业

找不到作业路径会返回异常信息
请求路径：/downloadById
请求方法：POST
权限要求：admin
请求参数：json

字段名	是否必填
taskId	Y
studentId	Y

参数示例：
{
“taskId”:“1”,
“studentId”:“1001”
}

5，查看单个学生的作业提交情况

请求路径：/getSubmissionsByStudentId
请求方法：POST
权限要求：admin
请求参数：json

字段名	是否必填
id	Y

参数示例：
1001
返回参数：
返回数据中的count是作业编号，如果为0代表这个人没交过作业
{
“role”: “admin”,
“data”: [
{
“count”: 1,
“name”: “作业一”,
“id”: 1,
“status”: 1
},
{
“count”: 2,
“name”: “作业二”,
“id”: 2,
“status”: 1
},
{
“count”: 0,
“name”: “作业三”,
“id”: 3,
“status”: 1
}
],
“errorCode”: 0,
“errorMsg”: “操作成功”
}

6，查看单个作业提交情况

请求路径：/getSubmissionByTaskId
请求方法：POST
权限要求：admin
请求参数：json

字段名	是否必填
taskId	Y

参数示例：
1
返回参数：
返回学生列表，其中salt为0时代表该学生没交过改作业
{
“role”: “admin”,
“data”: [
{
“password”: null,
“role”: null,
“salt”: “2”,
“name”: “学生1001”,
“id”: “1001”
},
{
“password”: null,
“role”: null,
“salt”: “0”,
“name”: “学生1002”,
“id”: “1002”
}
],
“errorCode”: 0,
“errorMsg”: “操作成功”
}

7，批量下载作业

请求路径：/batchDownload
请求方法：POST
权限要求：admin
请求参数：json

字段名	是否必填
taskId	Y

参数示例：
1

8，获取已删除/隐藏的作业

获得有人提交过作业后删除作业信息的情况
请求路径：/getHiddenTasks
请求方法：GET
权限要求：admin
请求参数：无

学生接口

9，查看全部作业和本人的提交情况

请求路径：/getSubmissions
请求方法：GET
权限要求：登录
请求参数：无
返回参数

10，下载自己的单个作业

请求路径：/downloadSelf
请求方法：POST
权限要求：登录
请求参数：json

字段名	是否必填
taskId	Y

参数示例：
1

11，作业上传

请求路径：/upload
请求方法：POST
权限要求：登录
请求参数：form-data

字段名	是否必填
taskId	Y
file	Y