前往小程序，Get更优阅读体验！
立即前往
文档建议反馈控制台
首页
学习
活动
专区
工具
TVP
最新优惠活动
文章/答案/技术大牛
发布
首页
学习
活动
专区
工具
TVP最新优惠活动
返回腾讯云官网
社区首页 >专栏 >教育平台项目后台管理系统：接口文档

教育平台项目后台管理系统：接口文档

作者头像
RendaZhang
发布于 2020-09-08 16:11:40
1.8K0
发布于 2020-09-08 16:11:40
举报
文章被收录于专栏：Renda

课程信息模块接口

接口 1：查询课程列表信息
  • 名称: findCourseList
  • 描述: 查询课程列表信息
  • URL: http://localhost:8080/lagou_edu_home/course
  • 请求方式: GET
  • 请求参数

字段

说明

类型

是否必须

备注

methodName

要访问的功能名

String

是

该字段必须填写，用来确定要访问是哪一个的方法

  • 请求参数示例:
代码语言：javascript
复制
methodName: "findCourseList"
  • 响应结果

字段

说明

类型

是否必须

备注

id

课程 id

int

是

course_name

课程名称

String

是

price

课程价格

double

是

课程的原价格

sort_num

课程排序

int

是

数字越大,越排在后面

status

课程状态

int

是

0-草稿，1-上架

  • 响应结果示例
代码语言：javascript
复制
[{
    "id": 1,
    "course_name": "32个Java面试必考点",
    "price": 8000,
    "sort_num": 1,
    "status": 1
}]
接口 2：条件查询课程信息
  • 名称: findByCourseNameAndStatus
  • 描述: 根据条件查询课程信息
  • URL: http://localhost:8080/lagou_edu_home/course
  • 请求方式: GET
  • 请求参数

字段

说明

类型

是否必需

备注

methodName

要访问的功能名

String

是

该字段必须填写，用来确定要访问是哪一个的方法

course_name

课程名称

String

否

选中要查询的课程名，查询课程信息

status

课程状态

int

否

选择课程状态，0-草稿，1-上架

  • 请求参数示例:
代码语言：javascript
复制
methodName: "findByCourseNameAndStatus",
course_name: "32个Java面试必考点",
status: "1"
  • 响应结果

字段

说明

类型

是否必须

备注

id

课程 id

int

是

course_name

课程名称

String

是

price

课程价格

double

是

课程的原价格

sortNum

课程排序

int

是

数字越大，越排在后面

status

课程状态

int

是

0-草稿，1-上架

  • 响应结果示例
代码语言：javascript
复制
[{
    "id": 1,
    "course_name": "32个Java面试必考点",
    "price": 8000,
    "sort_num": 1,
    "status": 1
}]
接口 3：保存 & 修改课程营销信息
  • 名称: courseSalesInfo
  • 描述: 保存课程相关的营销信息
  • URL: http://localhost:8080/lagou_edu_home/courseSalesInfo
  • 请求方式: POST
  • 请求参数

字段

说明

类型

是否必需

备注

id

课程 id

int

否

添加操作不用携带，修改操作必须携带 ID

course_name

课程名称

String

是

brief

课程简介

String

是

一句话介绍课程

teacher_name

讲师名称

String

是

teacher_info

讲师介绍

String

是

preview_first_field

课程概述 1

String

是

第一段描述，例如: 课程共 15 讲

preview_second_field

课程概述 2

String

是

第二段描述，例如: 每周五更新

discounts

售卖价格

double

是

课程的售卖价格

price

商品原价

double

是

课程的原销售价

price_tag

促销文案

String

是

例如: 立即抢购

share_image_title

分享图title

String

是

share_title

分享标题

String

是

share_description

分享描述

String

是

course_description

课程描述

String

是

file

文件

是

  • 请求参数示例 key: value 格式
代码语言：javascript
复制
file: 文件
course_name: 微服务架构
brief: 大厂架构师带你一起学
teacher_name: PDD
teacher_info: 技术精湛安全驾驶30年
preview_first_field: 共5讲
preview_second_field: 每周二更新
discounts: 88.8
price: 800.0
price_tag: 先到先得
share_image_title: hello word
share_title: IT修炼之路永无止境
share_description: 金牌讲师带你了解最新最牛的技术让你的实力再次进阶
course_description: 课程描述。。。
  • 响应结果

字段

说明

类型

是否必须

备注

status

表示执行成功或失败

int

是

0 表示成功，1 表示失败

msg

响应消息

String

是

  • 响应结果示例
代码语言：javascript
复制
成功
{"msg":"success","status":0}

失败
{"msg":"fail","status":1}
接口 4：根据 ID 获取课程营销信息
  • 名称: findCourseById
  • 描述: 根据 ID 查询课程信息
  • URL: http://localhost:8080/lagou_edu_home/course
  • 请求方式: GET
  • 请求参数

字段

说明

类型

是否必需

备注

methodName

要访问的功能名

String

是

该字段必须填写,用来确定要访问是哪一个的方法

id

课程 ID

int

是

根据 ID 查询

  • 请求参数示例
代码语言：javascript
复制
methodName: "findCourseById",
id: 10
  • 响应参数

字段

说明

类型

是否必需

备注

id

课程 ID

是

course_name

课程名称

String

是

brief

课程简介

String

是

一句话介绍课程

teacher_name

讲师名称

String

是

teacher_info

讲师介绍

String

是

preview_first_field

课程概述 1

String

是

第一段描述，例如: 课程共 15 讲

preview_second_field

课程概述 2

String

是

第二段描述，例如: 每周五更新

discounts

售卖价格

double

是

课程的售卖价格

price

商品原价

double

是

课程的原销售价

price_tag

促销文案

String

是

例如: 立即抢购

course_img_url

分享图 url

String

是

share_title

分享标题

String

是

share_image_title

分享图 title

String

是

share_description

分享描述

String

是

course_description

课程描述

String

是

status

课程状态

int

是

  • 响应数据示例
代码语言：javascript
复制
{
    "id": 19,
    "course_name": "微服务架构",
    "brief": "大厂架构师带你一起学",
    "teacher_name": "PDD",
    "teacher_info": "技术精湛,安全驾驶30年",
    "price": 800,
    "price_tag": "先到先得",
    "discounts": 88.8,
    "preview_first_field": "共5讲",
    "preview_second_field": "每周二更新",
    "course_img_url": "H:/upload/cacf91081ca14b4eb4b4700f10a382f6giao.jpg",
    "share_title": "IT修炼之路,永无止境",
    "share_description": "金牌讲师带你了解最新最牛的技术,让你的实力再次进阶!",
    "course_description": "课程描述。。。",
    "status": 0
}
接口 5：修改课程状态
  • 名称: updateCourseStatus
  • 描述: 修改课程状态
  • URL: http://localhost:8080/lagou_edu_home/course
  • 请求方式: GET
  • 请求参数

字段

说明

类型

是否必需

备注

methodName

要访问的功能名

String

是

该字段必须填写,用来确定要访问是哪一个的方法

id

课程 ID

int

是

  • 请求参数示例
代码语言：javascript
复制
methodName: "updateCourseStatus",
id: 18
  • 响应结果

字段

说明

类型

是否必须

备注

status

修改后的状态

int

是

课程状态，0-草稿，1-上架

  • 响应结果示例
代码语言：javascript
复制
草稿
{"status":0}
上架
{"status":1}

课程内容模块接口

接口 1：展示课程内容
  • 名称: findSectionAndLessonByCourseId
  • 描述: 根据课程ID查询章节与课时信息
  • URL: http://localhost:8080/lagou_edu_home/courseContent
  • 请求方式: GET
  • 请求参数

字段

说明

类型

是否必需

备注

methodName

要访问的功能名

String

是

该字段必须填写,用来确定要访问是哪一个的方法

course_id

课程 ID

int

是

根据课程ID查询课程相关的, 章节信息和课时信信

  • 请求参数示例
代码语言：javascript
复制
methodName:"findSectionAndLessonByCourseId",
course_id:"10"
  • 响应结果示例
代码语言：javascript
复制
[{
    "lessonList": [{
        "id": 32,
        "course_id": 10,
        "section_id": 5,
        "theme": "第一讲：如何给自己洗脑",
        "duration": 10,
        "is_free": 1,
        "order_num": 1,
        "status": 2,
        "create_time": "2020-08-23 20:37:02.0",
        "update_time": "2020-08-24 18:37:34.0",
        "isDel": 0
},
{
        "id": 33,
        "course_id": 10,
        "section_id": 5,
        "theme": "第二讲：如何给别人洗脑",
        "duration": 10,
        "is_free": 1,
        "order_num": 1,
        "status": 2,
        "create_time": "2020-08-23 20:37:02.0",
        "update_time": "2020-08-24 18:37:34.0",
        "isDel": 0
}],
    "id": 5,
    "course_id": 10,
    "section_name": "麻式太极",
    "description": "麻式太极拳，以柔克刚",
    "orderNum": 0,
    "status": 2,
    "create_time": "2020-08-11 10:55:10.0",
    "update_time": "2020-08-09 12:43:01.0",
    "isDel": 0
}]
接口 2：回显章节对应的课程信息
  • 名称: findCourseById
  • 描述: 回显章节对应的课程信息
  • URL: http://localhost:8080/lagou_edu_home/courseContent
  • 请求方式: GET
  • 请求参数

字段

说明

类型

是否必需

备注

methodName

要访问的功能名

String

是

该字段必须填写，用来确定要访问是哪一个的方法

course_id

课程 ID

int

是

根据课程 ID 查询课程相关的，章节信息和课时信信

  • 请求参数示例
代码语言：javascript
复制
methodName: "findCourseById",
 course_id: id
  • 响应结果

字段

说明

类型

是否必需

备注

id

课程 id

id

是

course_name

课程名称

String

是

  • 响应结果示例
代码语言：javascript
复制
{
    "id": 10,
    "course_name": "麻式太极"
}
接口 3：保存 & 修改章节信息
  • 名称: saveOrUpdateSection
  • 描述: 保存和修改章节信息
  • URL: http://localhost:8080/lagou_edu_home/courseContent
  • 请求方式: POST
  • 请求参数

字段

说明

类型

是否必需

备注

methodName

要访问的功能名

String

是

该字段必须填写,用来确定要访问是哪一个的方法

id

章节ID

int

否

添加操作不携带 id，修改操作必须携带 ID

course_id

课程ID

int

是

section_name

章节名称

String

是

description

章节描述

String

是

order_num

章节排序

int

是

  • 请求参数示例

JSON 格式数据

代码语言：javascript
复制
{
    "methodName": "saveOrUpdateSection",
    "course_id": 19,
    "section_name": "微服务架构",
    "description": "跟着Renda一起学习如何使用微服务",
    "order_num ": 0
}
  • 响应结果

字段

说明

类型

是否必须

备注

status

表示执行成功或失败

String

是

0 表示成功，1 表示失败

msg

响应消息

String

是

  • 响应结果示例
代码语言：javascript
复制
成功
{"msg":"success","status":0}

失败
{"msg":"fail","status":1}
接口 4：修改章节状态
  • 名称: updateSectionStatus
  • 描述: 修改章节状态
  • URL: http://localhost:8080/lagou_edu_home/courseContent
  • 请求方式: GET
  • 请求参数

字段

说明

类型

是否必需

备注

methodName

要访问的功能名

String

是

该字段必须填写,用来确定要访问是哪一个的方法

id

章节 ID

int

是

status

章节状态

int

是

状态：0-隐藏，1-待更新，2-已发布

  • 请求参数示例
代码语言：javascript
复制
"methodName": "updateSectionStatus",
"id": 2,
"status": 1
  • 响应结果

字段

说明

类型

是否必须

备注

status

表示执行成功或失败

String

是

0 表示成功，1 表示失败

msg

响应消息

String

是

本文参与 腾讯云自媒体同步曝光计划，分享自微信公众号。
原始发表：2020-08-24，如有侵权请联系 cloudcommunity@tencent.com 删除
编程算法
php
http

本文分享自 Renda 微信公众号，前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ，欢迎热爱写作的你一起参与！

编程算法
php
http
评论
登录后参与评论
0 条评论
热度
最新
登录 后参与评论
推荐阅读
LV.
文章
0
获赞
0
目录
  • 课程信息模块接口
    • 接口 1：查询课程列表信息
      • 接口 2：条件查询课程信息
        • 接口 3：保存 & 修改课程营销信息
          • 接口 4：根据 ID 获取课程营销信息
            • 接口 5：修改课程状态
            • 课程内容模块接口
              • 接口 1：展示课程内容
                • 接口 2：回显章节对应的课程信息
                  • 接口 3：保存 & 修改章节信息
                    • 接口 4：修改章节状态
                    领券

                    腾讯云开发者

                    扫码关注腾讯云开发者

                    扫码关注腾讯云开发者

                    领取腾讯云代金券

                    热门产品

                    热门推荐

                    更多推荐

                    Copyright © 2013 - 2024 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有 

                    深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 深公网安备号 44030502008569

                    腾讯云计算（北京）有限责任公司 京ICP证150476号 |  京ICP备11018762号 | 京公网安备号11010802020287

                    问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档

                    Copyright © 2013 - 2024 Tencent Cloud.

                    All Rights Reserved. 腾讯云 版权所有

                    登录 后参与评论