PCES后端Api文档

简介：Public course evaluation system rest 接口api

HOST:localhost:2285

联系人:PCES

Version:API V1.0

接口路径：/v2/api-docs

学生接口

修改邮箱

接口说明:根据邮箱验证码修改新邮箱

接口地址:/student/mail

请求方式：POST

consumes:["application/json"]

produces:["application/json"]

请求示例：

{
	"password": "",
	"updateInfo": "",
	"userId": "",
	"verificationCode": ""
}

请求参数：

参数名称	说明	in	是否必须	类型	schema
updateDTO	信息更新DTO	body	true	UpdateDTO	UpdateDTO

schema属性说明

UpdateDTO

参数名称	说明	in	是否必须	类型
password	用户密码	body	true	string
updateInfo	用户更新信息	body	true	string
userId	用户的登录ID	body	true	string
verificationCode	验证码	body	true	string

响应数据:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数说明:

参数名称	说明	类型
code	响应状态码	int32
data	响应数据	object
msg	响应状态描述	string

响应状态码说明:

状态码	说明	schema
200	OK	ResponseDTO
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

修改密码

接口说明:根据邮箱验证码和旧密码修改新邮箱

接口地址:/student/password

请求方式：POST

consumes:["application/json"]

produces:["application/json"]

请求示例：

{
	"password": "",
	"updateInfo": "",
	"userId": "",
	"verificationCode": ""
}

请求参数：

参数名称	说明	in	是否必须	类型	schema
updateDTO	信息更新DTO	body	true	UpdateDTO	UpdateDTO

schema属性说明

UpdateDTO

参数名称	说明	in	是否必须	类型
password	用户密码	body	true	string
updateInfo	用户更新信息	body	true	string
userId	用户的登录ID	body	true	string
verificationCode	验证码	body	true	string

响应数据:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数说明:

参数名称	说明	类型
code	响应状态码	int32
data	响应数据	object
msg	响应状态描述	string

响应状态码说明:

状态码	说明	schema
200	OK	ResponseDTO
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

获取学生信息

接口说明:根据学号获取学生信息

接口地址:/student/{studentId}

请求方式：GET

consumes:``

produces:["application/json"]

请求参数：

参数名称	说明	in	是否必须	类型	schema
studentId	学号	path	true	string

响应数据:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数说明:

参数名称	说明	类型
code	响应状态码	int32
data	响应数据	object
msg	响应状态描述	string

响应状态码说明:

状态码	说明	schema
200	OK	ResponseDTO
401	Unauthorized
403	Forbidden
404	Not Found

学院接口

所有学院信息

接口说明:获取所有学院信息，包含学院id和学院名称

接口地址:/college

请求方式：GET

consumes:``

produces:["application/json"]

请求参数：暂无

响应数据:

[
	{
		"id": 0,
		"name": ""
	}
]

响应参数说明:

参数名称	说明	类型	schema
id	学院ID	int32
name	学院名称	string

响应状态码说明:

状态码	说明	schema
200	OK	College
401	Unauthorized
403	Forbidden
404	Not Found

某学院所有专业

接口说明:根据学院ID获取该学院所有专业信息

接口地址:/college/{collegeId}

请求方式：GET

consumes:``

produces:["application/json"]

请求参数：

参数名称	说明	in	是否必须	类型	schema
collegeId	学院ID	path	true	integer

响应数据:

[
	{
		"collegeId": 0,
		"id": 0,
		"name": ""
	}
]

响应参数说明:

参数名称	说明	类型
collegeId	专业所在学院id	int32
id	专业ID	int32
name	专业名称	string

响应状态码说明:

状态码	说明	schema
200	OK	Major
401	Unauthorized
403	Forbidden
404	Not Found

搜索接口

搜索相关课程

接口说明:根据关键字通过课程名搜索

接口地址:/search/{searchStr}

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	说明	in	是否必须	类型	schema
searchStr	searchStr	path	true	string

响应数据:

[
	{
		"campus": "",
		"courseType": "",
		"id": 0,
		"introduction": "",
		"name": "",
		"remark": "",
		"schoolTime": "",
		"teacher": ""
	}
]

响应参数说明:

参数名称	说明	类型	schema
campus		string
courseType		string
id		int64
introduction		string
name		string
remark		string
schoolTime		string
teacher		string

响应状态码说明:

状态码	说明	schema
200	OK	Course
401	Unauthorized
403	Forbidden
404	Not Found

教师接口

修改邮箱

接口说明:根据邮箱验证码修改新邮箱

接口地址:/teacher/mail

请求方式：POST

consumes:["application/json"]

produces:["application/json"]

请求参数：暂无

响应数据:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数说明:

参数名称	说明	类型
code	响应状态码	int32
data	响应数据	object
msg	响应状态描述	string

响应状态码说明:

状态码	说明	schema
200	OK	ResponseDTO
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

修改密码

接口说明:根据邮箱验证码和旧密码修改新邮箱

接口地址:/teacher/password

请求方式：POST

consumes:["application/json"]

produces:["application/json"]

请求参数：暂无

响应数据:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数说明:

参数名称	说明	类型
code	响应状态码	int32
data	响应数据	object
msg	响应状态描述	string

响应状态码说明:

状态码	说明	schema
200	OK	ResponseDTO
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

标签接口

所有标签

接口说明:获取所有可添加标签

接口地址:/tag

请求方式：GET

consumes:``

produces:["application/json"]

请求参数：暂无

响应数据:

[
	{
		"id": 0,
		"tag": ""
	}
]

响应参数说明:

参数名称	说明	类型	schema
id		int64
tag		string

响应状态码说明:

状态码	说明	schema
200	OK	TagType
401	Unauthorized
403	Forbidden
404	Not Found

某课程所有已添加标签

接口说明:根据课程ID获取所有已添加标签

接口地址:/tag/{courseId}

请求方式：GET

consumes:``

produces:["application/json"]

请求参数：

参数名称	说明	in	是否必须	类型	schema
courseId	课程ID	path	true	integer

响应数据:

[
	{
		"courseId": 0,
		"id": 0,
		"num": 0,
		"tagId": 0
	}
]

响应参数说明:

参数名称	说明	类型	schema
courseId		int64
id		int64
num		int64
tagId		int64

响应状态码说明:

状态码	说明	schema
200	OK	Tag
401	Unauthorized
403	Forbidden
404	Not Found

注册接口

学生注册

接口说明:学生注册 Rest api

接口地址:/register/student

请求方式：POST

consumes:["application/json"]

produces:["application/json"]

请求示例：

{
	"activate": 0,
	"college": 0,
	"grade": "",
	"id": 0,
	"mail": "",
	"major": 0,
	"name": "",
	"nickname": "",
	"studentId": "",
	"type": 0
}

请求参数：

参数名称	说明	in	是否必须	类型	schema
student	student	body	true	Student	Student

schema属性说明

Student

参数名称	说明	in	是否必须	类型
activate	激活状态(1-激活，0-冻结)	body	false	int32
college	学院id	body	true	int32
grade	年级(例如2017)	body	true	string
id	ID	body	false	int32
mail	邮箱	body	true	string
major	专业id	body	true	int32
name	姓名	body	true	string
nickname	账户昵称	body	true	string
studentId	学号	body	true	string
type	学生类型(1-本科生，2-研究生)	body	true	int32

响应数据:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数说明:

参数名称	说明	类型
code	响应状态码	int32
data	响应数据	object
msg	响应状态描述	string

响应状态码说明:

状态码	说明	schema
200	OK	ResponseDTO
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

教师注册

接口说明:教师组测 Rest api

接口地址:/register/teacher

请求方式：POST

consumes:["application/json"]

produces:["application/json"]

请求示例：

null

请求参数：

参数名称	说明	in	是否必须	类型	schema
teacher	teacher	body	true	Teacher	Teacher

schema属性说明

Teacher

参数名称	说明	in	是否必须	类型	schema

响应数据:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数说明:

参数名称	说明	类型
code	响应状态码	int32
data	响应数据	object
msg	响应状态描述	string

响应状态码说明:

状态码	说明	schema
200	OK	ResponseDTO
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

登录接口

学生登录

接口说明:学生登录接口，登录成功后用户信息回填到ResponseDTO.data中

接口地址:/login/student

请求方式：POST

consumes:["application/json"]

produces:["application/json"]

请求示例：

{
	"password": "",
	"userId": ""
}

请求参数：

参数名称	说明	in	是否必须	类型	schema
loginDTO	登录信息DTO	body	true	LoginDTO	LoginDTO

schema属性说明

LoginDTO

参数名称	说明	in	是否必须	类型	schema
password	用户密码	body	true	string
userId	用户ID	body	true	string

响应数据:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数说明:

参数名称	说明	类型
code	响应状态码	int32
data	响应数据	object
msg	响应状态描述	string

响应状态码说明:

状态码	说明	schema
200	OK	ResponseDTO
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

教师登录

接口说明:教师登录接口，登录成功后用户信息回填到ResponseDTO.data中

接口地址:/login/teacher

请求方式：POST

consumes:["application/json"]

produces:["application/json"]

请求示例：

{
	"password": "",
	"userId": ""
}

请求参数：

参数名称	说明	in	是否必须	类型	schema
loginDTO	登录信息DTO	body	true	LoginDTO	LoginDTO

schema属性说明

LoginDTO

参数名称	说明	in	是否必须	类型	schema
password	用户密码	body	true	string
userId	用户ID	body	true	string

响应数据:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数说明:

参数名称	说明	类型
code	响应状态码	int32
data	响应数据	object
msg	响应状态描述	string

响应状态码说明:

状态码	说明	schema
200	OK	ResponseDTO
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

评论接口

添加评论

接口说明:根据课程ID给该课程添加评论

接口地址:/comment/add

请求方式：POST

consumes:["application/json"]

produces:["application/json"]

请求示例：

{
	"comment": "",
	"courseId": 0,
	"userId": 0
}

请求参数：

参数名称	说明	in	是否必须	类型	schema
comment	comment	body	true	Comment	Comment

schema属性说明

Comment

参数名称	in	是否必须	类型
comment	body	false	string
courseId	body	false	int64
userId	body	false	int64

响应数据:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数说明:

参数名称	说明	类型
code	响应状态码	int32
data	响应数据	object
msg	响应状态描述	string

响应状态码说明:

状态码	说明	schema
200	OK	ResponseDTO
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

删除评论

接口说明:根据评论id和用户信息删除评论

接口地址:/comment/{commentId}

请求方式：DELETE

consumes:``

produces:["application/json"]

请求参数：

参数名称	说明	in	是否必须	类型	schema
commentId	commentId	path	true	integer

响应数据:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数说明:

参数名称	说明	类型
code	响应状态码	int32
data	响应数据	object
msg	响应状态描述	string

响应状态码说明:

状态码	说明	schema
200	OK	ResponseDTO
204	No Content
401	Unauthorized
403	Forbidden

某课程评论

接口说明:根据课程ID获取该课程所有评论信息

接口地址:/comment/{courseId}

请求方式：GET

consumes:``

produces:["application/json"]

请求参数：

参数名称	说明	in	是否必须	类型	schema
courseId	courseId	path	true	integer

响应数据:

[
	{
		"comment": "",
		"courseId": 0,
		"userId": 0
	}
]

响应参数说明:

参数名称	说明	类型	schema
comment		string
courseId		int64
userId		int64

响应状态码说明:

状态码	说明	schema
200	OK	Comment
401	Unauthorized
403	Forbidden
404	Not Found

课程接口

获取所有专业课程

接口说明:获取所有专业课程

接口地址:/course/SpecializedCourse

请求方式：GET

consumes:``

produces:["application/json"]

请求参数：暂无

响应数据:

[
	{
		"campus": "",
		"courseType": "",
		"id": 0,
		"introduction": "",
		"name": "",
		"remark": "",
		"schoolTime": "",
		"teacher": ""
	}
]

响应参数说明:

参数名称	说明	类型	schema
campus		string
courseType		string
id		int64
introduction		string
name		string
remark		string
schoolTime		string
teacher		string

响应状态码说明:

状态码	说明	schema
200	OK	Course
401	Unauthorized
403	Forbidden
404	Not Found

获取所有公共基础课程

接口说明:获取所有公共基础课程

接口地址:/course/basicCourse

请求方式：GET

consumes:``

produces:["application/json"]

请求参数：暂无

响应数据:

[
	{
		"campus": "",
		"courseType": "",
		"id": 0,
		"introduction": "",
		"name": "",
		"remark": "",
		"schoolTime": "",
		"teacher": ""
	}
]

响应参数说明:

参数名称	说明	类型	schema
campus		string
courseType		string
id		int64
introduction		string
name		string
remark		string
schoolTime		string
teacher		string

响应状态码说明:

状态码	说明	schema
200	OK	Course
401	Unauthorized
403	Forbidden
404	Not Found

获取所有通识课程

接口说明:获取所有通识课程

接口地址:/course/commonCourse

请求方式：GET

consumes:``

produces:["application/json"]

请求参数：暂无

响应数据:

[
	{
		"campus": "",
		"courseType": "",
		"id": 0,
		"introduction": "",
		"name": "",
		"remark": "",
		"schoolTime": "",
		"teacher": ""
	}
]

响应参数说明:

参数名称	说明	类型	schema
campus		string
courseType		string
id		int64
introduction		string
name		string
remark		string
schoolTime		string
teacher		string

响应状态码说明:

状态码	说明	schema
200	OK	Course
401	Unauthorized
403	Forbidden
404	Not Found

根据ID获取课程

接口说明:根据用户Id获取课程详情

接口地址:/course/{id}

请求方式：GET

consumes:``

produces:["application/json"]

请求参数：

参数名称	说明	in	是否必须	类型	schema
id	课程Id	path	true	integer

响应数据:

{
	"campus": "",
	"courseType": "",
	"id": 0,
	"introduction": "",
	"name": "",
	"remark": "",
	"schoolTime": "",
	"teacher": ""
}

响应参数说明:

参数名称	说明	类型	schema
campus		string
courseType		string
id		int64
introduction		string
name		string
remark		string
schoolTime		string
teacher		string

响应状态码说明:

状态码	说明	schema
200	OK	Course
401	Unauthorized
403	Forbidden
404	Not Found

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

后端接口文档.md

后端接口文档.md

学生接口

修改邮箱

修改密码

获取学生信息

学院接口

所有学院信息

某学院所有专业

搜索接口

搜索相关课程

教师接口

修改邮箱

修改密码

标签接口

所有标签

某课程所有已添加标签

注册接口

学生注册

教师注册

登录接口

学生登录

教师登录

评论接口

添加评论

删除评论

某课程评论

课程接口

获取所有专业课程

获取所有公共基础课程

获取所有通识课程

根据ID获取课程

Files

后端接口文档.md

Latest commit

History

后端接口文档.md

File metadata and controls

学生接口

修改邮箱

修改密码

获取学生信息

学院接口

所有学院信息

某学院所有专业

搜索接口

搜索相关课程

教师接口

修改邮箱

修改密码

标签接口

所有标签

某课程所有已添加标签

注册接口

学生注册

教师注册

登录接口

学生登录

教师登录

评论接口

添加评论

删除评论

某课程评论

课程接口

获取所有专业课程

获取所有公共基础课程

获取所有通识课程

根据ID获取课程