我是靠谱客的博主 暴躁黑猫,最近开发中收集的这篇文章主要介绍谷粒学院api文档谷粒学院-田宏志,觉得挺不错的,现在分享给大家,希望可以做个参考。

概述

谷粒学院-田宏志

文章目录

  • 谷粒学院-田宏志
    • 1 鸣谢
    • 2 谷粒学院-在线教育项目
          • 项目说明
          • 联系方式
          • 文档版本
    • 3 课程管理前端
    • 3.1 课程详情方法
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 3.2 条件查询带分页的课程
      • 地址参数(Path Variable)
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 3.3 根据课程id查询课程信息
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 4 课程分类
    • 4.1 添加课程分类
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 4.2 课程分类列表
      • 响应体
          • 接口描述
    • 5 小节
    • 5.1 添加小节
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 5.2 删除小节
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 5.3 根据小节id查询
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 5.4 修改小节
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 6 前端微信扫码登录
    • 6.1 获取扫描人信息添加数据
      • 请求参数(Query Param)
      • 响应体
          • 接口描述
    • 6.2 生成微信扫描二维码
      • 响应体
          • 接口描述
    • 7 阿里云视频上传
    • 7.1 删除多个阿里云视频
      • 请求参数(Query Param)
      • 响应体
          • 接口描述
    • 7.2 根据视频id获取视频凭证
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 7.3 根据视频id删除阿里云视频
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 7.4 上传视频到阿里云
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 8 课程管理
    • 8.1 添加课程基本信息
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 8.2 删除课程
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 8.3 根据课程查询课程基本信息
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 8.4 课程列表
      • 响应体
          • 接口描述
    • 8.5 根据课程id查询课程确认信息
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 8.6 条件查询带分页课程列表
      • 地址参数(Path Variable)
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 8.7 分页查询课程列表
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 8.8 课程最终发布修改课程状态
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 8.9 根据id修改课程信息
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 9 阿里云文件管理
    • 9.1 文件上传
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 10 讲师管理
    • 10.1 添加讲师列表
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 10.2 所有讲师列表
      • 响应体
          • 接口描述
    • 10.3 根据id查询讲师
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 10.4 分页讲师列表
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 10.5 条件查询带分页讲师列表
      • 地址参数(Path Variable)
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 10.6 更新讲师
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 10.7 逻辑删除讲师
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 11 章节
    • 11.1 添加章节
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 11.2 删除章节
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 11.3 根据章节id查询
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 11.4 课程大纲列表
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 11.5 修改章节
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 12 前台查询课程名师
    • 12.1 查询前8条热门课程,查询前4条讲师
      • 响应体
          • 接口描述
    • 13 讲师管理前端
    • 13.1 讲师详情功能
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 13.2 分页查询所有讲师
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 14 前端登录注册接口
    • 14.1 查询某一天注册人数
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 14.2 根据token字符串获取用户信息
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 14.3 根据token获取用户信息
      • 响应体
          • 接口描述
    • 14.4 根据用户id获取用户信息
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 14.5 登录
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 14.6 注册
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 15 微信支付管理
    • 15.1 生成微信支付二维码接口
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 15.2 查询订单支付状态
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 16 评论
    • 16.1 分页查询所有评论
      • 地址参数(Path Variable)
      • 请求参数(Query Param)
      • 响应体
          • 接口描述
    • 16.2 添加评论
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 17 查询支付订单模块
    • 17.1 生成订单的方法
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 17.2 根据订单id查询订单信息
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 17.3 根据课程id和用户id查询订单中订单状态
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 18 显示管理
    • 18.1 info
      • 响应体
          • 接口描述
    • 18.2 logout
      • 响应体
          • 接口描述
    • 18.3 getMenu
      • 响应体
          • 接口描述
    • 19 用户管理
    • 19.1 根据id列表删除管理用户
      • 响应体
          • 接口描述
    • 19.2 根据用户分配角色
      • 请求参数(Query Param)
      • 响应体
          • 接口描述
    • 19.3 获取用户
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 19.4 删除管理用户
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 19.5 新增管理用户
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 19.6 根据用户获取角色数据
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 19.7 修改管理用户
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 19.8 获取管理用户分页列表
      • 地址参数(Path Variable)
      • 请求参数(Query Param)
      • 响应体
          • 接口描述
    • 20 菜单管理
    • 20.1 查询所有菜单
      • 响应体
          • 接口描述
    • 20.2 给角色分配权限
      • 请求参数(Query Param)
      • 响应体
          • 接口描述
    • 20.3 递归删除菜单
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 20.4 新增菜单
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 20.5 根据角色获取菜单
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 20.6 修改菜单
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 21 权限管理
    • 21.1 根据id列表删除角色
      • 响应体
          • 接口描述
    • 21.2 获取角色
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 21.3 删除角色
      • 地址参数(Path Variable)
      • 响应体
          • 接口描述
    • 21.4 新增角色
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 21.5 修改角色
      • 请求体(Request Body)
      • 响应体
          • 接口描述
    • 21.6 获取角色分页列表
      • 地址参数(Path Variable)
      • 请求参数(Query Param)
      • 响应体
          • 接口描述

1 鸣谢

本次CSA Java培训收获良多,非常感谢我的组长李学长提供的帮助和耐心的指导,同时也非常感谢所有评委老师的建议和指导。

2 谷粒学院-在线教育项目

项目说明

谷粒学院,是一个B2C模式的职业技能在线教育系统,分为前台用户系统和后台运营平台。
使用了微服务架构,前后端分离开发,前端主要根据视频老师所敲,同时,后端自己做。

前台用户系统包括:首页、课程、名师、问答(前端存在问题)、文章。后台管理系统包括:讲师管理、课程分类管理、课程管理、统计分析、Banner管理、订单管理等功能。

前端主要使用了Vue、element-ui、Nust、echarts等技术
后端主要使用了SpringBoot(快速构建Spring项目的脚手架)、SpringCloud(Nacos注册中心、 feign注册与发现、Hystrix断路器、Gateway网关)、mybatisPlus、EasyExcel、阿里云OSS的视频点播与短信服务、Redis、HttpClient等技术,开发历经一个月左右的时间。
另外采用nginx进行反向代理

联系方式
  • **联系人:**田宏志
  • **邮箱:**1605292886@qq.com
  • 网址:/https://blog.csdn.net/zhihong2002//
文档版本
1.0

3 课程管理前端

3.1 课程详情方法

GET /eduservice/coursefront/getCourseFrontInfo/{courseId}

地址参数(Path Variable)

参数名称默认值描述
courseIdcourseId

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

3.2 条件查询带分页的课程

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

地址参数(Path Variable)

参数名称默认值描述
pagepage

请求体(Request Body)

参数名称数据类型默认值不为空描述
buyCountSortstringfalse销量排序
gmtCreateSortstringfalse最新时间排序
priceSortstringfalse价格排序
subjectIdstringfalse二级类别id
subjectParentIdstringfalse一级类别id
teacherIdstringfalse讲师id
titlestringfalse课程名称

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

3.3 根据课程id查询课程信息

POST /eduservice/coursefront/getCourseInfoOrder/{id}

地址参数(Path Variable)

参数名称默认值描述
idid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
avatarstringfalse讲师头像
buyCountint32false销售数量
coverstringfalse课程封面图片路径
descriptionstringfalse课程简介
idstringfalse课程id
introstringfalse讲师资历,一句话说明讲师
lessonNumint32false总课时
pricenumberfalse课程销售价格,设置为0则可免费观看
subjectLevelOnestringfalse类别一级名称
subjectLevelOneIdstringfalse课程一级类别ID
subjectLevelTwostringfalse类别二级名称
subjectLevelTwoIdstringfalse课程二级类别ID
teacherIdstringfalse讲师ID
teacherNamestringfalse讲师姓名
titlestringfalse课程标题
viewCountint32false浏览数量
接口描述

4 课程分类

4.1 添加课程分类

POST /eduservice/subject/addSubject

请求体(Request Body)

参数名称数据类型默认值不为空描述
filestringfalsefile

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

4.2 课程分类列表

GET /eduservice/subject/getAllSubject

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

5 小节

5.1 添加小节

POST /eduservice/video/addVideo

请求体(Request Body)

参数名称数据类型默认值不为空描述
chapterIdstringfalse章节ID
courseIdstringfalse课程ID
durationnumberfalse视频时长(秒)
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
idstringfalse视频ID
isFreebooleanfalsefalse是否可以试听:0收费 1免费
playCountint32false播放次数
sizeint32false视频源文件大小(字节)
sortint32false排序字段
statusstringfalseEmpty未上传 Transcoding转码中 Normal正常
titlestringfalse节点名称
versionint32false乐观锁
videoOriginalNamestringfalse原始文件名称
videoSourceIdstringfalse云端视频资源

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

5.2 删除小节

DELETE /eduservice/video/deleteVideo/{id}

地址参数(Path Variable)

参数名称默认值描述
idid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

5.3 根据小节id查询

GET /eduservice/video/getVideoInfo/{id}

地址参数(Path Variable)

参数名称默认值描述
idid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

5.4 修改小节

POST /eduservice/video/updateVideo

请求体(Request Body)

参数名称数据类型默认值不为空描述
chapterIdstringfalse章节ID
courseIdstringfalse课程ID
durationnumberfalse视频时长(秒)
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
idstringfalse视频ID
isFreebooleanfalsefalse是否可以试听:0收费 1免费
playCountint32false播放次数
sizeint32false视频源文件大小(字节)
sortint32false排序字段
statusstringfalseEmpty未上传 Transcoding转码中 Normal正常
titlestringfalse节点名称
versionint32false乐观锁
videoOriginalNamestringfalse原始文件名称
videoSourceIdstringfalse云端视频资源

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

6 前端微信扫码登录

6.1 获取扫描人信息添加数据

GET /api/ucenter/wx/callback

请求参数(Query Param)

参数名称默认值描述
codecode
statestate

响应体

● 200 响应数据格式:JSON

接口描述

6.2 生成微信扫描二维码

GET /api/ucenter/wx/login

响应体

● 200 响应数据格式:JSON

接口描述

7 阿里云视频上传

7.1 删除多个阿里云视频

DELETE /eduvod/video/deleteBatch

请求参数(Query Param)

参数名称默认值描述
videoIdListvideoIdList

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

7.2 根据视频id获取视频凭证

GET /eduvod/video/getPlayAuth/{id}

地址参数(Path Variable)

参数名称默认值描述
idid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

7.3 根据视频id删除阿里云视频

DELETE /eduvod/video/removeAliyVideo/{id}

地址参数(Path Variable)

参数名称默认值描述
idid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

7.4 上传视频到阿里云

POST /eduvod/video/uploadAlyiVideo

请求体(Request Body)

参数名称数据类型默认值不为空描述
filestringfalsefile

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

8 课程管理

8.1 添加课程基本信息

POST /eduservice/course/addCourseInfo

请求体(Request Body)

参数名称数据类型默认值不为空描述
coverstringfalse课程封面图片路径
descriptionstringfalse课程简介
idstringfalse课程ID
lessonNumint32false总课时
pricenumberfalse课程销售价格,设置为0则可免费观看
statusstringfalse课程状态 Draft未发布 Normal已发布
subjectIdstringfalse二级分类ID
subjectParentIdstringfalse一级分类ID
teacherIdstringfalse课程讲师ID
titlestringfalse课程标题

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

8.2 删除课程

POST /eduservice/course/deleteCourse/{courseId}

地址参数(Path Variable)

参数名称默认值描述
courseIdcourseId

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

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

GET /eduservice/course/getCourseInfo/{courseId}

地址参数(Path Variable)

参数名称默认值描述
courseIdcourseId

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

8.4 课程列表

GET /eduservice/course/getCourseList

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

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

GET /eduservice/course/getPublishCourseInfo/{id}

地址参数(Path Variable)

参数名称默认值描述
idid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

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

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

地址参数(Path Variable)

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

请求体(Request Body)

参数名称数据类型默认值不为空描述
coverstringfalse课程封面图片路径
descriptionstringfalse课程简介
idstringfalse课程ID
lessonNumint32false总课时
pricenumberfalse课程销售价格,设置为0则可免费观看
statusstringfalse课程状态 Draft未发布 Normal已发布
subjectIdstringfalse二级分类ID
subjectParentIdstringfalse一级分类ID
teacherIdstringfalse课程讲师ID
titlestringfalse课程标题

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

8.7 分页查询课程列表

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

地址参数(Path Variable)

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

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

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

POST /eduservice/course/publishCourse/{id}

地址参数(Path Variable)

参数名称默认值描述
idid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

8.9 根据id修改课程信息

POST /eduservice/course/updateCourseInfo

请求体(Request Body)

参数名称数据类型默认值不为空描述
coverstringfalse课程封面图片路径
descriptionstringfalse课程简介
idstringfalse课程ID
lessonNumint32false总课时
pricenumberfalse课程销售价格,设置为0则可免费观看
statusstringfalse课程状态 Draft未发布 Normal已发布
subjectIdstringfalse二级分类ID
subjectParentIdstringfalse一级分类ID
teacherIdstringfalse课程讲师ID
titlestringfalse课程标题

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

9 阿里云文件管理

9.1 文件上传

POST /eduoss/fileoss

请求体(Request Body)

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

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

10 讲师管理

10.1 添加讲师列表

POST /eduservice/teacher/addTeacher

请求体(Request Body)

参数名称数据类型默认值不为空描述
avatarstringfalse讲师头像
careerstringfalse讲师资历,一句话说明讲师
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
idstringfalse讲师ID
introstringfalse讲师简介
isDeletedbooleanfalsefalse逻辑删除 1(true)已删除, 0(false)未删除
levelint32false头衔 1高级讲师 2首席讲师
namestringfalse讲师姓名
sortint32false排序

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

10.2 所有讲师列表

GET /eduservice/teacher/findAll

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

10.3 根据id查询讲师

GET /eduservice/teacher/getTeacher/{id}

地址参数(Path Variable)

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

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

10.4 分页讲师列表

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

地址参数(Path Variable)

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

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

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

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

地址参数(Path Variable)

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

请求体(Request Body)

参数名称数据类型默认值不为空描述
beginstring2019-01-01 10:10:10false查询开始时间
endstring2019-12-01 10:10:10false查询结束时间
levelint32false头衔 1高级讲师 2首席讲师
namestringfalse教师名称,模糊查询

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

10.6 更新讲师

POST /eduservice/teacher/updateTeacher

请求体(Request Body)

参数名称数据类型默认值不为空描述
avatarstringfalse讲师头像
careerstringfalse讲师资历,一句话说明讲师
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
idstringfalse讲师ID
introstringfalse讲师简介
isDeletedbooleanfalsefalse逻辑删除 1(true)已删除, 0(false)未删除
levelint32false头衔 1高级讲师 2首席讲师
namestringfalse讲师姓名
sortint32false排序

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

10.7 逻辑删除讲师

DELETE /eduservice/teacher/{id}

地址参数(Path Variable)

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

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

11 章节

11.1 添加章节

POST /eduservice/chapter/addChapter

请求体(Request Body)

参数名称数据类型默认值不为空描述
courseIdstringfalse课程ID
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
idstringfalse章节ID
sortint32false显示排序
titlestringfalse章节名称

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

11.2 删除章节

DELETE /eduservice/chapter/deleteChapter/{chapterId}

地址参数(Path Variable)

参数名称默认值描述
chapterIdchapterId

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

11.3 根据章节id查询

GET /eduservice/chapter/getChapterInfo/{chapterId}

地址参数(Path Variable)

参数名称默认值描述
chapterIdchapterId

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

11.4 课程大纲列表

GET /eduservice/chapter/getChapterVideo/{courseId}

地址参数(Path Variable)

参数名称默认值描述
courseIdcourseId

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

11.5 修改章节

POST /eduservice/chapter/updateChapter

请求体(Request Body)

参数名称数据类型默认值不为空描述
courseIdstringfalse课程ID
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
idstringfalse章节ID
sortint32false显示排序
titlestringfalse章节名称

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

12 前台查询课程名师

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

GET /eduservice/indexfront/index

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

13 讲师管理前端

13.1 讲师详情功能

GET /eduservice/teacherfront/getTeacherFrontInfo/{teacherId}

地址参数(Path Variable)

参数名称默认值描述
teacherIdteacherId

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

13.2 分页查询所有讲师

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

地址参数(Path Variable)

参数名称默认值描述
pagepage

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

14 前端登录注册接口

14.1 查询某一天注册人数

GET /educenter/member/countRegister/{day}

地址参数(Path Variable)

参数名称默认值描述
dayday

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

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

POST /educenter/member/getInfoUc/{id}

地址参数(Path Variable)

参数名称默认值描述
idid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
avatarstringfalse用户头像
idstringfalse会员id
nicknamestringfalse昵称
接口描述

14.3 根据token获取用户信息

GET /educenter/member/getMemberInfo

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

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

POST /educenter/member/getUserInfoOrder/{id}

地址参数(Path Variable)

参数名称默认值描述
idid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
ageint32false年龄
avatarstringfalse用户头像
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
idstringfalse会员id
isDeletedbooleanfalsefalse逻辑删除 1(true)已删除, 0(false)未删除
isDisabledbooleanfalsefalse是否禁用 1(true)已禁用, 0(false)未禁用
mobilestringfalse手机号
nicknamestringfalse昵称
openidstringfalse微信openid
passwordstringfalse密码
sexint32false性别 1 女,2 男
signstringfalse用户签名
接口描述

14.5 登录

POST /educenter/member/login

请求体(Request Body)

参数名称数据类型默认值不为空描述
ageint32false年龄
avatarstringfalse用户头像
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
idstringfalse会员id
isDeletedbooleanfalsefalse逻辑删除 1(true)已删除, 0(false)未删除
isDisabledbooleanfalsefalse是否禁用 1(true)已禁用, 0(false)未禁用
mobilestringfalse手机号
nicknamestringfalse昵称
openidstringfalse微信openid
passwordstringfalse密码
sexint32false性别 1 女,2 男
signstringfalse用户签名

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

14.6 注册

POST /educenter/member/register

请求体(Request Body)

参数名称数据类型默认值不为空描述
codestringfalse验证码
mobilestringfalse手机号
nicknamestringfalse昵称
passwordstringfalse密码

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

15 微信支付管理

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

GET /eduorder/paylog/createNative/{orderNo}

地址参数(Path Variable)

参数名称默认值描述
orderNoorderNo

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

15.2 查询订单支付状态

GET /eduorder/paylog/queryPayStatus/{orderNo}

地址参数(Path Variable)

参数名称默认值描述
orderNoorderNo

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

16 评论

16.1 分页查询所有评论

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

地址参数(Path Variable)

参数名称默认值描述
pagepage

请求参数(Query Param)

参数名称默认值描述
courseIdcourseId

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

16.2 添加评论

POST /eduservice/comment/saveComment

请求体(Request Body)

参数名称数据类型默认值不为空描述
avatarstringfalse会员头像
contentstringfalse评论内容
courseIdstringfalse课程id
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
idstringfalse评论ID
isDeletedbooleanfalsefalse逻辑删除 1(true)已删除, 0(false)未删除
memberIdstringfalse会员id
nicknamestringfalse会员昵称
teacherIdstringfalse讲师id

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

17 查询支付订单模块

17.1 生成订单的方法

POST /eduorder/order/createOrder/{courseId}

地址参数(Path Variable)

参数名称默认值描述
courseIdcourseId

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

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

GET /eduorder/order/getOrderInfo/{orderId}

地址参数(Path Variable)

参数名称默认值描述
orderIdorderId

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

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

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

地址参数(Path Variable)

参数名称默认值描述
courseIdcourseId

响应体

● 200 响应数据格式:JSON

接口描述

18 显示管理

18.1 info

GET /admin/acl/index/info

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

18.2 logout

POST /admin/acl/index/logout

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

18.3 getMenu

GET /admin/acl/index/menu

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

19 用户管理

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

DELETE /admin/acl/user/batchRemove

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

19.2 根据用户分配角色

POST /admin/acl/user/doAssign

请求参数(Query Param)

参数名称默认值描述
userIduserId
roleIdroleId

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

19.3 获取用户

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

地址参数(Path Variable)

参数名称默认值描述
idid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

19.4 删除管理用户

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

地址参数(Path Variable)

参数名称默认值描述
idid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

19.5 新增管理用户

POST /admin/acl/user/save

请求体(Request Body)

参数名称数据类型默认值不为空描述
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
idstringfalse会员id
isDeletedbooleanfalsefalse逻辑删除 1(true)已删除, 0(false)未删除
nickNamestringfalse昵称
passwordstringfalse密码
saltstringfalse用户头像
tokenstringfalse用户签名
usernamestringfalse微信openid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

19.6 根据用户获取角色数据

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

地址参数(Path Variable)

参数名称默认值描述
userIduserId

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

19.7 修改管理用户

PUT /admin/acl/user/update

请求体(Request Body)

参数名称数据类型默认值不为空描述
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
idstringfalse会员id
isDeletedbooleanfalsefalse逻辑删除 1(true)已删除, 0(false)未删除
nickNamestringfalse昵称
passwordstringfalse密码
saltstringfalse用户头像
tokenstringfalse用户签名
usernamestringfalse微信openid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

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

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

20 菜单管理

20.1 查询所有菜单

GET /admin/acl/permission

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

20.2 给角色分配权限

POST /admin/acl/permission/doAssign

请求参数(Query Param)

参数名称默认值描述
roleIdroleId
permissionIdpermissionId

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

20.3 递归删除菜单

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

地址参数(Path Variable)

参数名称默认值描述
idid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

20.4 新增菜单

POST /admin/acl/permission/save

请求体(Request Body)

参数名称数据类型默认值不为空描述
childrenarray[object]false下级
⇥ childrenarrayfalse下级
⇥ componentstringfalse组件路径
⇥ gmtCreatestringfalse创建时间
⇥ gmtModifiedstringfalse更新时间
⇥ iconstringfalse图标
⇥ idstringfalse编号
⇥ isDeletedbooleanfalsefalse逻辑删除 1(true)已删除, 0(false)未删除
⇥ levelint32false层级
⇥ namestringfalse名称
⇥ pathstringfalse访问路径
⇥ permissionValuestringfalse权限值
⇥ pidstringfalse所属上级
⇥ selectbooleanfalse
⇥ statusint32false状态(0:禁止,1:正常)
⇥ typeint32false类型(1:菜单,2:按钮)
componentstringfalse组件路径
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
iconstringfalse图标
idstringfalse编号
isDeletedbooleanfalsefalse逻辑删除 1(true)已删除, 0(false)未删除
levelint32false层级
namestringfalse名称
pathstringfalse访问路径
permissionValuestringfalse权限值
pidstringfalse所属上级
selectbooleanfalse
statusint32false状态(0:禁止,1:正常)
typeint32false类型(1:菜单,2:按钮)

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

20.5 根据角色获取菜单

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

地址参数(Path Variable)

参数名称默认值描述
roleIdroleId

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

20.6 修改菜单

PUT /admin/acl/permission/update

请求体(Request Body)

参数名称数据类型默认值不为空描述
childrenarray[object]false下级
⇥ childrenarrayfalse下级
⇥ componentstringfalse组件路径
⇥ gmtCreatestringfalse创建时间
⇥ gmtModifiedstringfalse更新时间
⇥ iconstringfalse图标
⇥ idstringfalse编号
⇥ isDeletedbooleanfalsefalse逻辑删除 1(true)已删除, 0(false)未删除
⇥ levelint32false层级
⇥ namestringfalse名称
⇥ pathstringfalse访问路径
⇥ permissionValuestringfalse权限值
⇥ pidstringfalse所属上级
⇥ selectbooleanfalse
⇥ statusint32false状态(0:禁止,1:正常)
⇥ typeint32false类型(1:菜单,2:按钮)
componentstringfalse组件路径
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
iconstringfalse图标
idstringfalse编号
isDeletedbooleanfalsefalse逻辑删除 1(true)已删除, 0(false)未删除
levelint32false层级
namestringfalse名称
pathstringfalse访问路径
permissionValuestringfalse权限值
pidstringfalse所属上级
selectbooleanfalse
statusint32false状态(0:禁止,1:正常)
typeint32false类型(1:菜单,2:按钮)

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

21 权限管理

21.1 根据id列表删除角色

DELETE /admin/acl/role/batchRemove

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

21.2 获取角色

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

地址参数(Path Variable)

参数名称默认值描述
idid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

21.3 删除角色

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

地址参数(Path Variable)

参数名称默认值描述
idid

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

21.4 新增角色

POST /admin/acl/role/save

请求体(Request Body)

参数名称数据类型默认值不为空描述
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
idstringfalse角色id
isDeletedbooleanfalsefalse逻辑删除 1(true)已删除, 0(false)未删除
remarkstringfalse备注
roleCodestringfalse角色编码
roleNamestringfalse角色名称

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

21.5 修改角色

PUT /admin/acl/role/update

请求体(Request Body)

参数名称数据类型默认值不为空描述
gmtCreatestringfalse创建时间
gmtModifiedstringfalse更新时间
idstringfalse角色id
isDeletedbooleanfalsefalse逻辑删除 1(true)已删除, 0(false)未删除
remarkstringfalse备注
roleCodestringfalse角色编码
roleNamestringfalse角色名称

响应体

● 200 响应数据格式:JSON

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

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

参数名称类型默认值不为空描述
codeint32false返回码
dataobjectfalse返回数据
messagestringfalse返回消息
successbooleanfalsefalse是否成功
接口描述

最后

以上就是暴躁黑猫为你收集整理的谷粒学院api文档谷粒学院-田宏志的全部内容,希望文章能够帮你解决谷粒学院api文档谷粒学院-田宏志所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错,欢迎将靠谱客网站推荐给程序员好友。

本图文内容来源于网友提供,作为学习参考使用,或来自网络收集整理,版权属于原作者所有。
点赞(55)

评论列表共有 0 条评论

立即
投稿
返回
顶部