Grain Academy api documentation

Guli College-Tian Hongzhi

1 Acknowledgments

I gained a lot from this CSA Java training. I am very grateful to my team leader, Mr. Li, for his help and patient guidance. I am also very grateful to all the judges and teachers for their suggestions and guidance.

2 Guli Academy-Online Education Program

project instruction

GuLi Academy is a B2C model vocational skills online education system, which is divided into a front-end user system and a back-end operation platform.
Using a microservice architecture, the front-end and back-end are developed separately. The front-end is mainly based on the instructions of the video teacher, and the back-end is done by ourselves.

The front-end user system includes: home page, courses, famous teachers, Q&A (front-end problems), and articles. The backend management system includes: lecturer management, course classification management, course management, statistical analysis, Banner management, order management and other functions.

The front-end mainly uses Vue, element-ui, Nust, echarts and other technologies
The back-end mainly uses SpringBoot (scaffolding for quickly building Spring projects), SpringCloud (Nacos registration center, feign registration and discovery, Hystrix circuit breaker, Gateway), mybatisPlus, EasyExcel, Alibaba Cloud OSS's video on demand and SMS services, Redis, HttpClient and other technologies, it took about a month to develop.
In addition, nginx is used for reverse proxy

Contact information

• **Contact:** Tian Hongzhi
• **Email:**[email protected]
• 网址：/https://blog.csdn.net/zhihong2002//

Document version

1.0

3 Course management front-end

3.1 Course details method

GET /eduservice/coursefront/getCourseFrontInfo/{courseId}

Address Parameter (Path Variable)

parameter name	default value	describe
courseId		courseId

response body

● 200 response data format: JSON

parameter name	type	default value	not null	describe
code	int32		false	return code
data	object		false	Return data
message	string		false	return message
success	boolean	false	false	whether succeed

Interface description

3.2 Conditional query for courses with pagination

POST /eduservice/coursefront/getCourseFrontList/{page}/{limit}

Address Parameter (Path Variable)

parameter name	default value	describe
page		page

Request Body

parameter name	type of data	default value	not null	describe
buyCountSort	string		false	Sales volume sorting
gmtCreateSort	string		false	Sort by latest time
priceSort	string		false	price sorting
subjectId	string		false	Secondary category id
subjectParentId	string		false	First level category id
teacherId	string		false	Lecturer ID
title	string		false	Course Title

response body

● 200 response data format: JSON

parameter name	type	default value	not null	describe
code	int32		false	return code
data	object		false	Return data
message	string		false	return message
success	boolean	false	false	whether succeed

Interface description

3.3 Query course information based on course ID

POST /eduservice/coursefront/getCourseInfoOrder/{id}

Address Parameter (Path Variable)

parameter name	default value	describe
id		id

response body

● 200 response data format: JSON

parameter name	type	default value	not null	describe
avatar	string		false	Lecturer avatar
buyCount	int32		false	Sales volume
cover	string		false	Course cover image path
description	string		false	Course Introduction
id	string		false	course id
intro	string		false	Lecturer qualifications, describe the lecturer in one sentence
lessonNum	int32		false	Total class hours
price	number		false	Course sales price, set to 0 to watch for free
subjectLevelOne	string		false	Category first-level name
subjectLevelOneId	string		false	Course level one category ID
subjectLevelTwo	string		false	Category secondary name
subjectLevelTwoId	string		false	Course secondary category ID
teacherId	string		false	Lecturer ID
teacherName	string		false	Lecturer's name
title	string		false	Course title
viewCount	int32		false	Number of views

Interface description

4 Course Classification

4.1 Add course classification

POST /eduservice/subject/addSubject

Request Body

parameter name	type of data	default value	not null	describe
file	string		false	file

response body

● 200 response data format: JSON

parameter name	type	default value	not null	describe
code	int32		false	return code
data	object		false	Return data
message	string		false	return message
success	boolean	false	false	whether succeed

Interface description

4.2 List of course categories

GET /eduservice/subject/getAllSubject

response body

● 200 response data format: JSON

parameter name	type	default value	not null	describe
code	int32		false	return code
data	object		false	Return data
message	string		false	return message
success	boolean	false	false	whether succeed

Interface description

5 bars

5.1 Add sections

POST /eduservice/video/addVideo

Request Body

parameter name	type of data	default value	not null	describe
chapterId	string		false	Chapter ID
courseId	string		false	Course ID
duration	number		false	Video duration (seconds)
gmtCreate	string		false	creation time
gmtModified	string		false	Update time
id	string		false	Video ID
isFree	boolean	false	false	Whether trial listening is available: 0 charge 1 free
playCount	int32		false	Views
size	int32		false	Video source file size (bytes)
sort	int32		false	sort field
status	string		false	Empty is not uploaded. Transcoding is transcoding. Normal.
title	string		false	Node name
version	int32		false	optimistic locking
videoOriginalName	string		false	Original file name
videoSourceId	string		false	Cloud video resources

response body

● 200 response data format: JSON

parameter name	type	default value	not null	describe
code	int32		false	return code
data	object		false	Return data
message	string		false	return message
success	boolean	false	false	whether succeed

Interface description

5.2 Delete a section

DELETE /eduservice/video/deleteVideo/{id}

Address Parameter (Path Variable)

parameter name	default value	describe
id		id

response body

● 200 response data format: JSON

parameter name	type	default value	not null	describe
code	int32		false	return code
data	object		false	Return data
message	string		false	return message
success	boolean	false	false	whether succeed

Interface description

5.3 Query based on section id

GET /eduservice/video/getVideoInfo/{id}

Address Parameter (Path Variable)

parameter name	default value	describe
id		id

response body

● 200 response data format: JSON

parameter name	type	default value	not null	describe
code	int32		false	return code
data	object		false	Return data
message	string		false	return message
success	boolean	false	false	whether succeed

Interface description

5.4 Modify section

POST /eduservice/video/updateVideo

Request Body

parameter name	type of data	default value	not null	describe
chapterId	string		false	Chapter ID
courseId	string		false	Course ID
duration	number		false	Video duration (seconds)
gmtCreate	string		false	creation time
gmtModified	string		false	Update time
id	string		false	Video ID
isFree	boolean	false	false	Whether trial listening is available: 0 charge 1 free
playCount	int32		false	Views
size	int32		false	Video source file size (bytes)
sort	int32		false	sort field
status	string		false	Empty is not uploaded. Transcoding is transcoding. Normal.
title	string		false	Node name
version	int32		false	optimistic locking
videoOriginalName	string		false	Original file name
videoSourceId	string		false	Cloud video resources

response body

● 200 response data format: JSON

parameter name	type	default value	not null	describe
code	int32		false	return code
data	object		false	Return data
message	string		false	return message
success	boolean	false	false	whether succeed

Interface description

6 Front-end WeChat scan code login

6.1 Obtain scanned person information and add data

GET /api/ucenter/wx/callback

Request parameters (Query Param)

parameter name	default value	describe
code		code
state		state

response body

● 200 response data format: JSON

Interface description

6.2 Generate QR code to scan on WeChat

GET /api/ucenter/wx/login

response body

● 200 response data format: JSON

Interface description

7 Alibaba Cloud video upload

7.1 Delete multiple Alibaba Cloud videos

DELETE /eduvod/video/deleteBatch

Request parameters (Query Param)

parameter name	default value	describe
videoIdList		videoIdList

response body

● 200 response data format: JSON

parameter name	type	default value	not null	describe
code	int32		false	return code
data	object		false	Return data
message	string		false	return message
success	boolean	false	false	whether succeed

Interface description

7.2 Obtain video credentials based on video ID

GET /eduvod/video/getPlayAuth/{id}

Address Parameter (Path Variable)

parameter name	default value	describe
id		id

response body

● 200 response data format: JSON

parameter name	type	default value	not null	describe
code	int32		false	return code
data	object		false	Return data
message	string		false	return message
success	boolean	false	false	whether succeed

Interface description

7.3 Delete Alibaba Cloud videos based on video ID

DELETE /eduvod/video/removeAliyVideo/{id}

地址参数（Path Variable）

参数名称	默认值	描述
id		id

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

7.4 上传视频到阿里云

POST /eduvod/video/uploadAlyiVideo

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
file	string		false	file

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

8 课程管理

8.1 添加课程基本信息

POST /eduservice/course/addCourseInfo

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
cover	string		false	课程封面图片路径
description	string		false	课程简介
id	string		false	课程ID
lessonNum	int32		false	总课时
price	number		false	课程销售价格，设置为0则可免费观看
status	string		false	课程状态 Draft未发布 Normal已发布
subjectId	string		false	二级分类ID
subjectParentId	string		false	一级分类ID
teacherId	string		false	课程讲师ID
title	string		false	课程标题

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

8.2 删除课程

POST /eduservice/course/deleteCourse/{courseId}

地址参数（Path Variable）

参数名称	默认值	描述
courseId		courseId

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

8.3 根据课程查询课程基本信息

GET /eduservice/course/getCourseInfo/{courseId}

地址参数（Path Variable）

参数名称	默认值	描述
courseId		courseId

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

8.4 课程列表

GET /eduservice/course/getCourseList

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

8.5 根据课程id查询课程确认信息

GET /eduservice/course/getPublishCourseInfo/{id}

地址参数（Path Variable）

参数名称	默认值	描述
id		id

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

8.6 条件查询带分页课程列表

POST /eduservice/course/pageCourseCondition/{current}/{limit}

地址参数（Path Variable）

参数名称	默认值	描述
current		当前页码

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
cover	string		false	课程封面图片路径
description	string		false	课程简介
id	string		false	课程ID
lessonNum	int32		false	总课时
price	number		false	课程销售价格，设置为0则可免费观看
status	string		false	课程状态 Draft未发布 Normal已发布
subjectId	string		false	二级分类ID
subjectParentId	string		false	一级分类ID
teacherId	string		false	课程讲师ID
title	string		false	课程标题

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

8.7 分页查询课程列表

POST /eduservice/course/pageListCourse/{current}/{limit}

地址参数（Path Variable）

参数名称	默认值	描述
current		当前页码

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

8.8 课程最终发布修改课程状态

POST /eduservice/course/publishCourse/{id}

地址参数（Path Variable）

参数名称	默认值	描述
id		id

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

8.9 根据id修改课程信息

POST /eduservice/course/updateCourseInfo

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
cover	string		false	课程封面图片路径
description	string		false	课程简介
id	string		false	课程ID
lessonNum	int32		false	总课时
price	number		false	课程销售价格，设置为0则可免费观看
status	string		false	课程状态 Draft未发布 Normal已发布
subjectId	string		false	二级分类ID
subjectParentId	string		false	一级分类ID
teacherId	string		false	课程讲师ID
title	string		false	课程标题

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

9 阿里云文件管理

9.1 文件上传

POST /eduoss/fileoss

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
file	string		false	文件

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

10 讲师管理

10.1 添加讲师列表

POST /eduservice/teacher/addTeacher

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
avatar	string		false	讲师头像
career	string		false	讲师资历,一句话说明讲师
gmtCreate	string		false	创建时间
gmtModified	string		false	更新时间
id	string		false	讲师ID
intro	string		false	讲师简介
isDeleted	boolean	false	false	逻辑删除 1（true）已删除， 0（false）未删除
level	int32		false	头衔 1高级讲师 2首席讲师
name	string		false	讲师姓名
sort	int32		false	排序

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

10.2 所有讲师列表

GET /eduservice/teacher/findAll

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

10.3 根据id查询讲师

GET /eduservice/teacher/getTeacher/{id}

地址参数（Path Variable）

参数名称	默认值	描述
id		讲师ID

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

10.4 分页讲师列表

GET /eduservice/teacher/pageTeacher/{current}/{limit}

地址参数（Path Variable）

参数名称	默认值	描述
current		当前页码

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

10.5 条件查询带分页讲师列表

POST /eduservice/teacher/pageTeacherCondition/{current}/{limit}

地址参数（Path Variable）

参数名称	默认值	描述
current		当前页码

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
begin	string	2019-01-01 10:10:10	false	查询开始时间
end	string	2019-12-01 10:10:10	false	查询结束时间
level	int32		false	头衔 1高级讲师 2首席讲师
name	string		false	教师名称,模糊查询

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

10.6 更新讲师

POST /eduservice/teacher/updateTeacher

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
avatar	string		false	讲师头像
career	string		false	讲师资历,一句话说明讲师
gmtCreate	string		false	创建时间
gmtModified	string		false	更新时间
id	string		false	讲师ID
intro	string		false	讲师简介
isDeleted	boolean	false	false	逻辑删除 1（true）已删除， 0（false）未删除
level	int32		false	头衔 1高级讲师 2首席讲师
name	string		false	讲师姓名
sort	int32		false	排序

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

10.7 逻辑删除讲师

DELETE /eduservice/teacher/{id}

地址参数（Path Variable）

参数名称	默认值	描述
id		讲师ID

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

11 章节

11.1 添加章节

POST /eduservice/chapter/addChapter

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
courseId	string		false	课程ID
gmtCreate	string		false	创建时间
gmtModified	string		false	更新时间
id	string		false	章节ID
sort	int32		false	显示排序
title	string		false	章节名称

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

11.2 删除章节

DELETE /eduservice/chapter/deleteChapter/{chapterId}

地址参数（Path Variable）

参数名称	默认值	描述
chapterId		chapterId

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

11.3 根据章节id查询

GET /eduservice/chapter/getChapterInfo/{chapterId}

地址参数（Path Variable）

参数名称	默认值	描述
chapterId		chapterId

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

11.4 课程大纲列表

GET /eduservice/chapter/getChapterVideo/{courseId}

地址参数（Path Variable）

参数名称	默认值	描述
courseId		courseId

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

11.5 修改章节

POST /eduservice/chapter/updateChapter

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
courseId	string		false	课程ID
gmtCreate	string		false	创建时间
gmtModified	string		false	更新时间
id	string		false	章节ID
sort	int32		false	显示排序
title	string		false	章节名称

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

12 前台查询课程名师

12.1 查询前8条热门课程，查询前4条讲师

GET /eduservice/indexfront/index

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

13 讲师管理前端

13.1 讲师详情功能

GET /eduservice/teacherfront/getTeacherFrontInfo/{teacherId}

地址参数（Path Variable）

参数名称	默认值	描述
teacherId		teacherId

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

13.2 分页查询所有讲师

POST /eduservice/teacherfront/getTeacherFrontList/{page}/{limit}

地址参数（Path Variable）

参数名称	默认值	描述
page		page

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

14 前端登录注册接口

14.1 查询某一天注册人数

GET /educenter/member/countRegister/{day}

地址参数（Path Variable）

参数名称	默认值	描述
day		day

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

14.2 根据token字符串获取用户信息

POST /educenter/member/getInfoUc/{id}

地址参数（Path Variable）

参数名称	默认值	描述
id		id

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
avatar	string		false	用户头像
id	string		false	会员id
nickname	string		false	昵称

接口描述

14.3 根据token获取用户信息

GET /educenter/member/getMemberInfo

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

14.4 根据用户id获取用户信息

POST /educenter/member/getUserInfoOrder/{id}

地址参数（Path Variable）

参数名称	默认值	描述
id		id

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
age	int32		false	年龄
avatar	string		false	用户头像
gmtCreate	string		false	创建时间
gmtModified	string		false	更新时间
id	string		false	会员id
isDeleted	boolean	false	false	逻辑删除 1（true）已删除， 0（false）未删除
isDisabled	boolean	false	false	是否禁用 1（true）已禁用， 0（false）未禁用
mobile	string		false	手机号
nickname	string		false	昵称
openid	string		false	微信openid
password	string		false	密码
sex	int32		false	性别 1 女，2 男
sign	string		false	用户签名

接口描述

14.5 登录

POST /educenter/member/login

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
age	int32		false	年龄
avatar	string		false	用户头像
gmtCreate	string		false	创建时间
gmtModified	string		false	更新时间
id	string		false	会员id
isDeleted	boolean	false	false	逻辑删除 1（true）已删除， 0（false）未删除
isDisabled	boolean	false	false	是否禁用 1（true）已禁用， 0（false）未禁用
mobile	string		false	手机号
nickname	string		false	昵称
openid	string		false	微信openid
password	string		false	密码
sex	int32		false	性别 1 女，2 男
sign	string		false	用户签名

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

14.6 注册

POST /educenter/member/register

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
code	string		false	验证码
mobile	string		false	手机号
nickname	string		false	昵称
password	string		false	密码

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

15 微信支付管理

15.1 生成微信支付二维码接口

GET /eduorder/paylog/createNative/{orderNo}

地址参数（Path Variable）

参数名称	默认值	描述
orderNo		orderNo

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

15.2 查询订单支付状态

GET /eduorder/paylog/queryPayStatus/{orderNo}

地址参数（Path Variable）

参数名称	默认值	描述
orderNo		orderNo

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

16 评论

16.1 分页查询所有评论

GET /eduservice/comment/getCommentList/{page}/{limit}

地址参数（Path Variable）

参数名称	默认值	描述
page		page

请求参数(Query Param)

参数名称	默认值	描述
courseId		courseId

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

16.2 添加评论

POST /eduservice/comment/saveComment

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
avatar	string		false	会员头像
content	string		false	评论内容
courseId	string		false	课程id
gmtCreate	string		false	创建时间
gmtModified	string		false	更新时间
id	string		false	评论ID
isDeleted	boolean	false	false	逻辑删除 1（true）已删除， 0（false）未删除
memberId	string		false	会员id
nickname	string		false	会员昵称
teacherId	string		false	讲师id

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

17 查询支付订单模块

17.1 生成订单的方法

POST /eduorder/order/createOrder/{courseId}

地址参数（Path Variable）

参数名称	默认值	描述
courseId		courseId

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

17.2 根据订单id查询订单信息

GET /eduorder/order/getOrderInfo/{orderId}

地址参数（Path Variable）

参数名称	默认值	描述
orderId		orderId

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

17.3 根据课程id和用户id查询订单中订单状态

GET /eduorder/order/isBuyCourse/{courseId}/{memberId}

地址参数（Path Variable）

参数名称	默认值	描述
courseId		courseId

响应体

● 200 响应数据格式：JSON

接口描述

18 显示管理

18.1 info

GET /admin/acl/index/info

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

18.2 logout

POST /admin/acl/index/logout

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

18.3 getMenu

GET /admin/acl/index/menu

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

19 用户管理

19.1 根据id列表删除管理用户

DELETE /admin/acl/user/batchRemove

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

19.2 根据用户分配角色

POST /admin/acl/user/doAssign

请求参数(Query Param)

参数名称	默认值	描述
userId		userId
roleId		roleId

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

19.3 获取用户

GET /admin/acl/user/get/{id}

地址参数（Path Variable）

参数名称	默认值	描述
id		id

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

19.4 删除管理用户

DELETE /admin/acl/user/remove/{id}

地址参数（Path Variable）

参数名称	默认值	描述
id		id

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

19.5 新增管理用户

POST /admin/acl/user/save

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
gmtCreate	string		false	创建时间
gmtModified	string		false	更新时间
id	string		false	会员id
isDeleted	boolean	false	false	逻辑删除 1（true）已删除， 0（false）未删除
nickName	string		false	昵称
password	string		false	密码
salt	string		false	用户头像
token	string		false	用户签名
username	string		false	微信openid

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

19.6 根据用户获取角色数据

GET /admin/acl/user/toAssign/{userId}

地址参数（Path Variable）

参数名称	默认值	描述
userId		userId

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

19.7 修改管理用户

PUT /admin/acl/user/update

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
gmtCreate	string		false	创建时间
gmtModified	string		false	更新时间
id	string		false	会员id
isDeleted	boolean	false	false	逻辑删除 1（true）已删除， 0（false）未删除
nickName	string		false	昵称
password	string		false	密码
salt	string		false	用户头像
token	string		false	用户签名
username	string		false	微信openid

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

19.8 获取管理用户分页列表

GET /admin/acl/user/{page}/{limit}

地址参数（Path Variable）

参数名称	默认值	描述
page		当前页码

请求参数(Query Param)

参数名称	默认值	描述
id		会员id
username		微信openid
password		密码
nickName		昵称
salt		用户头像
token		用户签名
isDeleted		逻辑删除 1（true）已删除， 0（false）未删除
gmtCreate		创建时间
gmtModified		更新时间

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

20 菜单管理

20.1 查询所有菜单

GET /admin/acl/permission

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

20.2 给角色分配权限

POST /admin/acl/permission/doAssign

请求参数(Query Param)

参数名称	默认值	描述
roleId		roleId
permissionId		permissionId

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

20.3 递归删除菜单

DELETE /admin/acl/permission/remove/{id}

地址参数（Path Variable）

参数名称	默认值	描述
id		id

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

20.4 新增菜单

POST /admin/acl/permission/save

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
children	array[object]		false	下级
⇥ children	array		false	下级
⇥ component	string		false	组件路径
⇥ gmtCreate	string		false	创建时间
⇥ gmtModified	string		false	更新时间
⇥ icon	string		false	图标
⇥ id	string		false	编号
⇥ isDeleted	boolean	false	false	逻辑删除 1（true）已删除， 0（false）未删除
⇥ level	int32		false	层级
⇥ name	string		false	名称
⇥ path	string		false	访问路径
⇥ permissionValue	string		false	权限值
⇥ pid	string		false	所属上级
⇥ select	boolean		false
⇥ status	int32		false	状态(0:禁止,1:正常)
⇥ type	int32		false	类型(1:菜单,2:按钮)
component	string		false	组件路径
gmtCreate	string		false	创建时间
gmtModified	string		false	更新时间
icon	string		false	图标
id	string		false	编号
isDeleted	boolean	false	false	逻辑删除 1（true）已删除， 0（false）未删除
level	int32		false	层级
name	string		false	名称
path	string		false	访问路径
permissionValue	string		false	权限值
pid	string		false	所属上级
select	boolean		false
status	int32		false	状态(0:禁止,1:正常)
type	int32		false	类型(1:菜单,2:按钮)

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

20.5 根据角色获取菜单

GET /admin/acl/permission/toAssign/{roleId}

地址参数（Path Variable）

参数名称	默认值	描述
roleId		roleId

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

20.6 修改菜单

PUT /admin/acl/permission/update

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
children	array[object]		false	下级
⇥ children	array		false	下级
⇥ component	string		false	组件路径
⇥ gmtCreate	string		false	创建时间
⇥ gmtModified	string		false	更新时间
⇥ icon	string		false	图标
⇥ id	string		false	编号
⇥ isDeleted	boolean	false	false	逻辑删除 1（true）已删除， 0（false）未删除
⇥ level	int32		false	层级
⇥ name	string		false	名称
⇥ path	string		false	访问路径
⇥ permissionValue	string		false	权限值
⇥ pid	string		false	所属上级
⇥ select	boolean		false
⇥ status	int32		false	状态(0:禁止,1:正常)
⇥ type	int32		false	类型(1:菜单,2:按钮)
component	string		false	组件路径
gmtCreate	string		false	创建时间
gmtModified	string		false	更新时间
icon	string		false	图标
id	string		false	编号
isDeleted	boolean	false	false	逻辑删除 1（true）已删除， 0（false）未删除
level	int32		false	层级
name	string		false	名称
path	string		false	访问路径
permissionValue	string		false	权限值
pid	string		false	所属上级
select	boolean		false
status	int32		false	状态(0:禁止,1:正常)
type	int32		false	类型(1:菜单,2:按钮)

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

21 权限管理

21.1 根据id列表删除角色

DELETE /admin/acl/role/batchRemove

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

21.2 获取角色

GET /admin/acl/role/get/{id}

地址参数（Path Variable）

参数名称	默认值	描述
id		id

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

21.3 删除角色

DELETE /admin/acl/role/remove/{id}

地址参数（Path Variable）

参数名称	默认值	描述
id		id

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

21.4 新增角色

POST /admin/acl/role/save

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
gmtCreate	string		false	创建时间
gmtModified	string		false	更新时间
id	string		false	角色id
isDeleted	boolean	false	false	逻辑删除 1（true）已删除， 0（false）未删除
remark	string		false	备注
roleCode	string		false	角色编码
roleName	string		false	角色名称

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

21.5 修改角色

PUT /admin/acl/role/update

请求体(Request Body)

参数名称	数据类型	默认值	不为空	描述
gmtCreate	string		false	创建时间
gmtModified	string		false	更新时间
id	string		false	角色id
isDeleted	boolean	false	false	逻辑删除 1（true）已删除， 0（false）未删除
remark	string		false	备注
roleCode	string		false	角色编码
roleName	string		false	角色名称

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述

21.6 获取角色分页列表

GET /admin/acl/role/{page}/{limit}

地址参数（Path Variable）

参数名称	默认值	描述
page		当前页码

请求参数(Query Param)

参数名称	默认值	描述
id		角色id
roleName		角色名称
roleCode		角色编码
remark		备注
isDeleted		逻辑删除 1（true）已删除， 0（false）未删除
gmtCreate		创建时间
gmtModified		更新时间

响应体

● 200 响应数据格式：JSON

参数名称	类型	默认值	不为空	描述
code	int32		false	返回码
data	object		false	返回数据
message	string		false	返回消息
success	boolean	false	false	是否成功

接口描述