課程管理模塊接口文檔

課程信息模塊接口

接口 1：查詢課程列表信息

• 名稱: findCourseList
• 描述: 查詢課程列表信息
• URL: http://localhost:8080/lagou_edu_home/course
• 請求方式: GET
• 請求參數(shù)

字段說明類型是否必須備注

methodName	要訪問的功能名	String	是	該字段必須填寫，用來確定要訪問是哪一個的方法

• 請求參數(shù)示例:

methodName: "findCourseList"

• 響應(yīng)結(jié)果

字段說明類型是否必須備注

id	課程 id	int	是
course_name	課程名稱	String	是
price	課程價格	double	是	課程的原價格
sort_num	課程排序	int	是	數(shù)字越大,越排在后面
status	課程狀態(tài)	int	是	0-草稿，1-上架

• 響應(yīng)結(jié)果示例

[{"id": 1,"course_name": "32個Java面試必考點","price": 8000,"sort_num": 1,"status": 1 }]

接口 2：條件查詢課程信息

• 名稱: findByCourseNameAndStatus
• 描述: 根據(jù)條件查詢課程信息
• URL: http://localhost:8080/lagou_edu_home/course
• 請求方式: GET
• 請求參數(shù)

字段說明類型是否必需備注

methodName	要訪問的功能名	String	是	該字段必須填寫，用來確定要訪問是哪一個的方法
course_name	課程名稱	String	否	選中要查詢的課程名，查詢課程信息
status	課程狀態(tài)	int	否	選擇課程狀態(tài)，0-草稿，1-上架

• 請求參數(shù)示例:

methodName: "findByCourseNameAndStatus", course_name: "32個Java面試必考點", status: "1"

• 響應(yīng)結(jié)果

字段說明類型是否必須備注

id	課程 id	int	是
course_name	課程名稱	String	是
price	課程價格	double	是	課程的原價格
sortNum	課程排序	int	是	數(shù)字越大，越排在后面
status	課程狀態(tài)	int	是	0-草稿，1-上架

• 響應(yīng)結(jié)果示例

[{"id": 1,"course_name": "32個Java面試必考點","price": 8000,"sort_num": 1,"status": 1 }]

接口 3：保存 & 修改課程營銷信息

• 名稱: courseSalesInfo
• 描述: 保存課程相關(guān)的營銷信息
• URL: http://localhost:8080/lagou_edu_home/courseSalesInfo
• 請求方式: POST
• 請求參數(shù)

字段說明類型是否必需備注

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	分享標(biāo)題	String	是
share_description	分享描述	String	是
course_description	課程描述	String	是
file	文件		是

• 請求參數(shù)示例 key: value 格式

file: 文件 course_name: 微服務(wù)架構(gòu) brief: 大廠架構(gòu)師帶你一起學(xué) teacher_name: PDD teacher_info: 技術(shù)精湛安全駕駛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: 金牌講師帶你了解最新最牛的技術(shù)讓你的實力再次進(jìn)階 course_description: 課程描述。。。

• 響應(yīng)結(jié)果

字段說明類型是否必須備注

status	表示執(zhí)行成功或失敗	int	是	0 表示成功，1 表示失敗
msg	響應(yīng)消息	String	是

• 響應(yīng)結(jié)果示例

成功 {"msg":"success","status":0}失敗 {"msg":"fail","status":1}

接口 4：根據(jù) ID 獲取課程營銷信息

• 名稱: findCourseById
• 描述: 根據(jù) ID 查詢課程信息
• URL: http://localhost:8080/lagou_edu_home/course
• 請求方式: GET
• 請求參數(shù)

字段說明類型是否必需備注

methodName	要訪問的功能名	String	是	該字段必須填寫,用來確定要訪問是哪一個的方法
id	課程 ID	int	是	根據(jù) ID 查詢

• 請求參數(shù)示例

methodName: "findCourseById", id: 10

• 響應(yīng)參數(shù)

字段說明類型是否必需備注

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	分享標(biāo)題	String	是
share_image_title	分享圖 title	String	是
share_description	分享描述	String	是
course_description	課程描述	String	是
status	課程狀態(tài)	int	是

• 響應(yīng)數(shù)據(jù)示例

{"id": 19,"course_name": "微服務(wù)架構(gòu)","brief": "大廠架構(gòu)師帶你一起學(xué)","teacher_name": "PDD","teacher_info": "技術(shù)精湛,安全駕駛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": "金牌講師帶你了解最新最牛的技術(shù),讓你的實力再次進(jìn)階!","course_description": "課程描述。。。","status": 0 }

接口 5：修改課程狀態(tài)

• 名稱: updateCourseStatus
• 描述: 修改課程狀態(tài)
• URL: http://localhost:8080/lagou_edu_home/course
• 請求方式: GET
• 請求參數(shù)

字段說明類型是否必需備注

methodName	要訪問的功能名	String	是	該字段必須填寫,用來確定要訪問是 哪一個的方法
id	課程 ID	int	是

• 請求參數(shù)示例

methodName: "updateCourseStatus", id: 18

• 響應(yīng)結(jié)果

字段說明類型是否必須備注

status	修改后的狀態(tài)	int	是	課程狀態(tài)，0-草稿，1-上架

• 響應(yīng)結(jié)果示例

草稿{"status":0} 上架{"status":1}

---

課程內(nèi)容模塊接口

接口 1：展示課程內(nèi)容

• 名稱: findSectionAndLessonByCourseId
• 描述: 根據(jù)課程ID查詢章節(jié)與課時信息
• URL: http://localhost:8080/lagou_edu_home/courseContent
• 請求方式: GET
• 請求參數(shù)

字段說明類型是否必需備注

methodName	要訪問的功能名	String	是	該字段必須填寫,用來確定要訪問是 哪一個的方法
course_id	課程 ID	int	是	根據(jù)課程ID查詢課程相關(guān)的, 章節(jié)信息和課時信信

• 請求參數(shù)示例

methodName:"findSectionAndLessonByCourseId", course_id:"10"

• 響應(yīng)結(jié)果示例

[{"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：回顯章節(jié)對應(yīng)的課程信息

• 名稱: findCourseById
• 描述: 回顯章節(jié)對應(yīng)的課程信息
• URL: http://localhost:8080/lagou_edu_home/courseContent
• 請求方式: GET
• 請求參數(shù)

字段說明類型是否必需備注

methodName	要訪問的功能名	String	是	該字段必須填寫，用來確定要訪問是哪一個的方法
course_id	課程 ID	int	是	根據(jù)課程 ID 查詢課程相關(guān)的，章節(jié)信息和課時信信

• 請求參數(shù)示例

methodName: "findCourseById",course_id: id

• 響應(yīng)結(jié)果

字段說明類型是否必需備注

id	課程 id	id	是
course_name	課程名稱	String	是

• 響應(yīng)結(jié)果示例

{"id": 10,"course_name": "麻式太極" }

接口 3：保存 & 修改章節(jié)信息

• 名稱: saveOrUpdateSection
• 描述: 保存和修改章節(jié)信息
• URL: http://localhost:8080/lagou_edu_home/courseContent
• 請求方式: POST
• 請求參數(shù)

字段說明類型是否必需備注

methodName	要訪問的功能名	String	是	該字段必須填寫,用來確定要訪問是哪一個的方法
id	章節(jié)ID	int	否	添加操作不攜帶 id，修改操作必須攜帶 ID
course_id	課程ID	int	是
section_name	章節(jié)名稱	String	是
description	章節(jié)描述	String	是
order_num	章節(jié)排序	int	是

• 請求參數(shù)示例

JSON 格式數(shù)據(jù)

{"methodName": "saveOrUpdateSection","course_id": 19,"section_name": "微服務(wù)架構(gòu)","description": "跟著Renda一起學(xué)習(xí)如何使用微服務(wù)","order_num ": 0 }

• 響應(yīng)結(jié)果

字段說明類型是否必須備注

status	表示執(zhí)行成功或失敗	String	是	0 表示成功，1 表示失敗
msg	響應(yīng)消息	String	是

• 響應(yīng)結(jié)果示例

成功 {"msg":"success","status":0}失敗 {"msg":"fail","status":1}

接口 4：修改章節(jié)狀態(tài)

• 名稱: updateSectionStatus
• 描述: 修改章節(jié)狀態(tài)
• URL: http://localhost:8080/lagou_edu_home/courseContent
• 請求方式: GET
• 請求參數(shù)

字段說明類型是否必需備注

methodName	要訪問的功能名	String	是	該字段必須填寫,用來確定要訪問是哪一個的方法
id	章節(jié) ID	int	是
status	章節(jié)狀態(tài)	int	是	狀態(tài)：0-隱藏，1-待更新，2-已發(fā)布

• 請求參數(shù)示例

"methodName": "updateSectionStatus", "id": 2, "status": 1

• 響應(yīng)結(jié)果

字段說明類型是否必須備注

status	表示執(zhí)行成功或失敗	String	是	0 表示成功，1 表示失敗
msg	響應(yīng)消息	String	是

總結(jié)

以上是生活随笔為你收集整理的教育平台项目后台管理系统：接口文档的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。