数据库作业简历管理网站API列表

login

1. 登录功能

• 请求方式：POST
• 请求参数：

参数	说明	类型
username	学号	string
password	密码	string

• 返回参数

参数	说明	类型
id	用户id	int
username	学号	string
name	姓名	string
email	电子邮件	string
status	用户身份（1表示学生，2表示管理员）	int
created_at	创建时间	string,符合rfc3399标准
last_login	上次登录时间	string,符合rfc3399标准

user

1. 注册功能

• 请求方式：POST
• 请求参数：

参数	说明	类型
username	学号	string
password	密码	string
email	电子邮件	string
name	用户姓名	string

• 返回参数

无参数

2. 查询我的信息

• 请求方式：GET
• 请求参数：

无参数

• 返回参数:

同login

3. 修改我的信息功能

• 请求方式：PUT
• 请求参数：

参数	说明	类型
name	用户姓名	string
email	电子邮件地址	string

可以有空缺的参数。

• 返回参数:

无参数

reset-password(暂定，先不要写实现，后面没时间就算了)

1. 重置密码功能

• 请求方式：POST
• 请求参数：

参数	说明	类型
username	学号	string
validation	验证码(向管理员请求)	string
password	新密码	string

• 返回参数:

无参数

logout

1. 登出功能

• 请求方式：GET
• 请求参数： 无参数
• 返回参数： 无参数

reward

1. 创建获奖记录

• 请求方式：POST
• 请求参数：

参数	说明	类型
name	获奖名称	string
rank	获奖等第（可选）	string
host	主办方（可选）	string
date	获奖日期	string

• 返回参数：

参数	说明	类型
id	创建的获奖记录id	int

2. 删除获奖记录

• 请求方式：DELETE
• 请求参数：

参数	说明	类型
id	要删除的获奖记录id	int

id放在url中

• 返回参数：

无参数

3. 查询获奖记录

• 请求方式：GET
• 请求参数：

参数	说明	类型
id	要查询的获奖记录id	int

• 返回参数：

参数	说明	类型
name	获奖名称	string
rank	获奖等第	string
host	主办方	string
date	获奖日期	string
file	证书文件路径	如果为空字符串，则没有上传文件

4. 更新获奖记录

• 请求方式：PUT
• 请求参数：

参数	说明	类型
id	要更新的获奖记录id	int

id放在url中

其他参数同创建，可以有空缺的参数

• 返回参数： 无参数

upload-reward

1. 上传证书文件功能

• 请求方式：POST
• 请求参数：

参数	说明	类型
id	获奖记录id	int
file	获奖记录文件	bytes

id放在url中

• 返回参数：

无参数

download-reward

1. 下载证书文件功能

• 请求方式：GET
• 请求参数：

参数	说明	类型
id	获奖记录id	int

• 返回参数：

无参数，直接返回二进制文件

my-reward

1. 查询我的获奖记录列表

• 请求方式：GET
• 请求参数：

参数	说明	类型
start	起始位置	int
end	结束位置	int

• 返回参数：

参数	说明	类型
totalNum	上传的获奖记录的个数	int
items	获奖列表	list
- id	获奖id	int
- name	奖项名称	string
- created_at	上传时间	string,符合rfc3399标准

resume

1. 创建一份简历

• 请求方式：POST
• 请求参数：

参数	说明	类型
name	简历名称	string
target	投递意向	string

• 返回参数：

无参数

2. 删除一份简历

• 请求方式：DELETE
• 请求参数：

参数	说明	类型
id	简历id	int

id放在url中

• 返回参数：

无参数

3. 查询一份简历

• 请求方式：GET
• 请求参数：

参数	说明	类型
id	简历id	int

• 返回参数：

参数	说明	类型
name	简历名称	string
target	投递意向	string
file	简历文件路径，如果为空字符串，则没有上传文件	string

4. 更改一份简历

• 请求方式：PUT
• 请求参数：

参数	说明	类型
id	简历id	int

id放在url中

其他参数同创建简历，可有空缺参数

• 返回参数：

无参数

my-resume

1. 查询我的简历

• 请求方式：GET
• 请求参数：

参数	说明	类型
start	起始位置	int
end	结束位置	int

• 返回参数：

参数	说明	类型
totalNum	上传的简历的个数	int
items	简历列表	list
- id	简历id	int
- name	简历名称	string
- name	上传时间	string,符合rfc3399标准

upload-resume

1. 上传简历文件功能

• 请求方式：POST
• 请求参数：

参数	说明	类型
id	简历id	int
file	简历文件	bytes

id放在url中

• 返回参数：

无参数

download-resume

1. 下载简历文件功能

• 请求方式：GET
• 请求参数：

参数	说明	类型
id	简历id	int

• 返回参数：

无参数，直接返回二进制文件