SSM 单体框架 - 教育平台后台管理系统：接口文档

最新推荐文章于 2024-07-17 15:38:20 发布
最新推荐文章于 2024-07-17 15:38:20 发布
阅读量486 收藏 1
点赞数
分类专栏： 软件开发 文章标签： 接口 spring mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_40286307/article/details/108670024
版权
这是一份详细的SSM（Spring、SpringMVC、Mybatis）单体框架教育平台后台管理系统的接口文档，涵盖了课程、广告、用户、权限等模块的增删改查及状态管理接口。包括课程的条件查询、图片上传、新建/修改课程，广告位列表查询、广告分页查询，用户分页查询、权限角色分配等关键功能。
摘要由CSDN通过智能技术生成

接口文档

1.课程模块

1.1 查询 & 条件查询

接口地址: http://localhost:8080/ssm_web/course/findCourseByCondition

请求方式: POST

接口描述: 分页获取课程列表数据&多条件查询

请求参数:

参数名称 是否必须 数据类型
currentPage false integer(int32)
pageSize false integer(int32)
courseName false string
status false integer(int32)

请求示例:

{
   
	"currentPage": 1,
	"pageSize": 5,
	"courseName": "Vue.js 3.0 核心源码解析",
	"status": 1
}

响应参数:

参数名称 类型
success boolean
state integer(int32)
message string
content object

响应示例:

{
   
	"success": true,
	"state": 0,
	"message": "响应成功",
	"content": {
   课程数据}
}

1.2 图片上传接口

接口地址: http://localhost:8080/ssm_web/course/courseUpload

请求方式: POST

接口描述: 课程模块图片上传

请求参数:

file=1597112871741.JPG

响应参数:

参数名称 类型
success boolean
state integer(int32)
message string
content object

响应示例:

{
   
    "success": true,
    "state": 200,
    "message": "响应成功",
    "content": {
   
        "fileName": "1597112871741.JPG",
        "filePath": "http://localhost:8080/upload/1597112871741.JPG"
    }
}

1.3 新建 & 修改课程以及讲师接口

接口地址: http://localhost:8080/ssm_web/course/saveOrUpdateCourse

请求方式: POST

接口描述: 新建或修改课程信息以及关联的讲师信息

请求参数:

字段 说明 类型 是否必需 备注
id 课程id int 否 添加操作不携带 ID，修改操作必须携带 ID
courseName 课程名称 String 是
brief 课程简介 String 是 一句话介绍课程
teacherName 讲师名称 String 是
description 讲师介绍 String 是
position 讲师职位 String 是
previewFirstField 课程概述1 String 是 第一段描述 例如: 课程共15讲
previewSecondField 课程概述2 String 是 第二段描述 例如: 每周五更新
discounts 售卖价格 double 是 课程的售卖价格
price 商品原价 double 是 课程的原销售价
discountsTag 活动标签 String 是 例如: 立即抢购
courseImgUrl 课程图片url String 是
courseListImg 封面图url String 是
sortNum 课程排序 int 是
course_description_mark_down 课程描述 String 是
sales 销量 int 是

请求示例

// 新增
{
   
    "courseName": "大数据云计算",
    "brief": "海量大数据课程",
    "teacherName": "维尼",
    "description": "多年企业实战经验",
    "position": "高级讲师",
    "previewFirstField": "共10讲",
    "previewSecondField": "每周四更新",
    "discounts": 66.6,
    "price": 88,
    "discountsTag": "先到先得",
    "courseImgUrl": "http://localhost:8080/upload/1596520226925.jpg",
    "courseListImg": "http://localhost:8080/upload/1596520226925.jpg",
    "sortNum": 1,
    "courseDescriptionMarkDown": "介绍当前流行大数据技术，数据技术原理，并介绍其思想，介绍大数据技术培训课程，概要介绍。",
    "sales": 100
}

// 修改
{
   
    "id": 32,
    "courseName": "全栈工程师",
    "brief": "掌握多种技能，胜任前端与后端",
    "teacherName": "药水哥",
    "description": "多年企业实战经验",
    "position": "高级讲师",
    "previewFirstField": "共10讲",
    "previewSecondField": "每周四更新",
    "discounts": 66.6,
    "price": 88,
    "discountsTag": "先到先得",
    "courseImgUrl": "http://localhost:8080/upload/1596520226925.jpg",
    "courseListImg": "http://localhost:8080/upload/1596520226925.jpg",
    "sortNum": 1,
    "courseDescriptionMarkDown": "介绍当前流行大数据技术，数据技术原理，并介绍其思想，介绍大数据技术培训课程，概要介绍。",
    "sales": 100
}

响应参数:

参数名称 类型
success boolean
state integer(int32)
message string
content object

响应示例

{
   
    "success": true,
    "state": 200,
    "message": "响应成功",
    "content": null
}

1.4 根据 id 查询课程以及讲师信息

  • 名称: findCourseById
  • 描述: 根据 id 查询课程信息以及关联的讲师信息
  • URL: http://localhost:8080/ssm_web/course/findCourseById
  • 请求方式: GET
  • 请求实例：http://localhost:8080/ssm_web/course/findCourseById?id=16
  • 请求参数
字段 说明 类型 是否必需
id 课程id int 是
  • 响应结果示例
{
    "success": true,
    "state": 200,
    "message": "响应成功",
    "content": 课程信息以及关联的讲师信息
}

1.5 课程状态管理

接口地址: http://localhost:8080/ssm_web/course/updateCourseStatus

请求方式: GET

接口描述: 修改课程状态

请求参数:

参数名称 参数说明 是否必须 数据类型 备注
id 课程id true int
status 课程状态 true int 最新的状态值

请求示例:

http://localhost:8080/ssm_web/course/updateCourseStatus?status=1&id=15

响应参数:

参数名称 类型
success boolean
state integer(int32)
message string
content object

响应示例:

{
   
    "success": true,
    "state": 200,
    "message": "响应成功",
    "content": {
   
        "status": 1
    }
}

1.6 课程内容展示

接口地址: http://localhost:8080/ssm_web/courseContent/findSectionAndLesson

请求方式: GET

接口描述: 根据课程 ID 查询章节与关联的课时信息

请求参数:

参数名称 参数说明 是否必须 数据类型
courseId 课程id true int
  • 请求示例
http://localhost:8080/ssm_web/courseContent/findSectionAndLesson?courseId=7
  • 响应结果示例
{
   
    "success": true,
    "state": 200,
    "message": "响应成功",
    "content": [
        {
   
            "id": 7,
            "courseId": 7,
            "sectionName": "开篇词 | 从小白到文案高手，手把手教你写出爆款文案",
            "description": "你好，我是兔妈！第一次见面，我用几句话简单介绍下自己",
            "createTime": null,
            "updateTime": null,
            "isDe": 0,
            "orderNum": 1,
            "status": 2,
            "lessonList": [
                {
   
                    "id": 9,
                    "courseId": 7,
                    "sectionId": 7,
                    "theme": "手把手教你写出爆款文案",
                    "duration": 0,
                    "isFree": 0,
                    "createTime": null,
                    "updateTime": null,
                    "isDel": 0,
                    "orderNum": 1,
                    "status": 2
                },
                {
   
                    "id": 8,
                    "courseId": 7,
                    "sectionId": 7,
                    "theme": "从小白到文案高手",
                    "duration": 0,
                    "isFree": 1,
                    "createTime": null,
                    "updateTime": null,
                    "isDel": 0,
                    "orderNum": 1,
                    "status": 2
                }
            ]
        },
        {
   
            "id": 8,
            "courseId": 7,
            "sectionName": "重点内容总结",
            "description": "重点内容总结",
            "createTime": null,
            "updateTime": null,
            "isDe": 0,
            "orderNum": 2,
            "status": 2,
            "lessonList": [
                {
   
                    "id": 11,
                    "courseId": 7,
                    "sectionId": 8,
                    "theme": "内容总结",
                    "duration": 0,
                    "isFree": 0,
                    "createTime": null,
                    "updateTime": null,
                    "isDel": 0,
                    "orderNum": 2,
                    "status": 2
                },
                {
   
                    "id": 10,
                    "courseId": 7,
                    "sectionId": 8,
                    "theme": "重点内容",
                    "duration": 0,
                    "isFree"
最低0.47元/天 解锁文章
RendaZhang
关注
专栏目录
教育平台项目后台管理系统：接口文档
qq_40286307的博客
08-24 1060
课程管理模块接口文档 课程信息模块接口 接口 1：查询课程列表信息 名称: findCourseList 描述: 查询课程列表信息 URL: http://localhost:8080/lagou_edu_home/course 请求方式: GET 请求参数 字段 说明 类型 是否必须 备注 methodName 要访问的功能名 String 是 该字段必须填写，用来确定要访问是哪一个的方法 请求参数示例: methodName: "findCourseList" 响应结
06_04_SSM项目接口文档
weixin_41596178的博客
03-03 287
SSM项目接口文档 1.课程模块 1.1 查询&条件查询 接口地址: http://localhost:8080/ssm-web/course/findCourseByCondition 请求方式: POST 接口描述: 分页获取课程列表数据&多条件查询 请求参数: 参数名称 参数说明 in 是否必须 数据类型 schema courseName false string status false integer(int32) 请求示例: { "cour
前后端分离项目规范——接口文档示例
最新发布
计算机程序定制、毕业项目
07-17 1202
前后端分离项目规范——接口文档示例
后台接口文档
weixin_30311605的博客
08-15 290
用户登录 接口请求调用说名： http://www.xxx.xxx:8080/项目名/vue/userAction_login.action 参数 是否必须 说明 Name 是 用户名 Pwd 是 密码 登录成功返回json数据： ...
06_04_SSM项目接口文档(权限模块、登录授权)
weixin_41596178的博客
03-05 324
4.权限模块 4.1 角色模块 4.1.1 角色列表查询&条件查询 名称: findAllRole 描述: 查询菜单列表 URL: http://localhost:8080/ssm-web/role/findAllRole 请求方式: POST 请求参数 {name:"角色名称"} 响应结果示例 { "success": true, "state": 200, "message": "响应成功", "content": [{ "id": 1, "code": "ADMIN
ssm框架图片上传与显示_SSM 单体框架 - 教育平台后台管理系统：接口文档
weixin_39913141的博客
12-09 198
CSDN: SSM 单体框架 - 教育平台后台管理系统：接口文档SSM 项目接口文档1.课程模块1.1 查询 & 条件查询接口地址: http://localhost:8080/ssm_web/course/findCourseByCondition请求方式: POST接口描述: 分页获取课程列表数据&多条件查询请求参数:| 参数名称 | 是否必须 | 数据类型 ...
SSM 单体框架 - 教育平台后台管理系统：权限模块开发
qq_40286307的博客
09-21 402
权限概念介绍 权限：权利（能做的）和限制（不能做的），在权限范围内做好自己的事情 认证： 验证用户名密码是否正确的过程 授权： 对用户所能访问的资源进行控制（动态显示菜单、URL 级别的权限控制） 实现权限系统的原因 首先系统需要进行登陆才能访问 其次不同登陆用户要有不同的权利，而且要有不同的菜单（例如财务经理针对系统中财务相关模块进行操作，人事经理针对系统中人事模块进行操作） 权限控制基本原理 ACL（Access Control Lists） ACL 是最早也是最基本的一种访问控制机制，它的原理非常简单
SSM 单体框架 - 教育平台后台管理系统：Maven 进阶使用，课程模块
qq_40286307的博客
09-19 806
项目架构 项目介绍 教育后台管理系统是提供给相关业务人员使用的一个后台管理系统，业务人员可以在这个后台管理系统中，对课程信息、广告信息、用户信息、 权限信息等数据进行维护。 在 Java web 阶段已经完成了教育后台管理系统中的课程模块，接下来将对教育后台管理系统进行升级改造，基于 SSM 框架来完成课程信息模块、广告信息模块、用户信息模块、权限信息模块。 技术选型 前端技术选型 Vue.js：是一套用于构建用户界面的渐进式 JavaScript 框架 Element UI 库：是饿了么前端出品的基于
基于SpringBoot+SSM实现的后台开发框架
西里古里的博客
08-17 1821
一款 Java 语言基于SpringBoot2、Layui、Thymeleaf、MybatisPlus、Shiro、MySQL等框架精心打造的一款模块化、插件化、高性能的前后端分离架构敏捷开发框架，可用于快速搭建后台管理系统，本着简化开发、提升开发效率的初衷，框架自研了一套个性化的组件，实现了可插拔的组件式开发方式：单图上传、多图上传、下拉选择、开关按钮、单选按钮、多选按钮、图片裁剪、富文本编辑器等等一系列个性化、轻量级的组件，是一款真正意义上实现组件化开发的敏捷开发框架，框架已集成了完整的RBAC权限架构
基于ssm的医院挂号系统
程序员光剑
05-25 356
基于ssm的医院挂号系统 作者：禅与计算机程序设计艺术 1. 背景介绍 1.1 医院挂号系统的重要性 在现代医疗服务中,医院挂号系统扮演着至关重要的角色。它是连接患者与医疗机构的桥梁,直接影响到医疗服务的质量和效率。传统的人工挂
电商管理后台 API 接口文档 - 副本.md
09-05
电商管理后台 API 接口文档
电商管理后台 API 接口文档.md
07-18
电商管理后台 API 接口文档
电商管理后台 API 接口文档
01-27
电商管理后台 API 接口文档
ssm框架整合及Rest风格接口实现
06-24
1.基于Maven的SSM框架整合即Spring+SpringMVC+Mybatis三大框架进行整合。 2.REST接口的实现示例 PDF文档。
SSM基于接口开发的简单搭建
07-16
http://blog.csdn.net/hy771213/article/details/51922130搭配博客 SSM+maven的项目搭建,可以直接用在项目中,如需其他框架,在pom文件里修改再添加配置就行
CIEP 后台管理系统(API文档)
ଳxin的博客
01-15 420
一、层级管理： 通过层级管理，展示园区-企业-部门关系。 点击某园区，默认展示对应的企业列表； 点击某企业，默认展示对应的部门列表； 点击某部门，默认展示对应的员工列表； 二、新增员工： 对照数据表，增删前端表单字段； 所属企业、性别处下拉为空； 三、合并通知和公告： 发布通知这里，选择对个人发送，这里的展示并不合理。 建议/改进： 1.暂时去掉个人通知，后续如果需要，再做这个功能。 2.send_range，原意思是：发送范围；现在改为用1-通知；0-公告 ..
图书馆后台管理业务接口文档
x181116的博客
03-08 535
1.用户登录 1.1 用户登录验证接口 • 请求路径: /user/login • 请求方式: POST • 请求参数: 参数名称 参数说明 备注 name 用户名 不能为null password 密码 不能为null •响应数据BookStrap对象 ...
java ssm api接口,Java SSM添加Swagger接口文档
weixin_42126749的博客
03-13 262
1.需要的Jar包依赖io.springfoxspringfox-swagger22.7.0io.springfoxspringfox-swagger-ui2.7.0org.springframeworkspring-web4.3.14.RELEASE2.Swagger配置类import org.springframework.context.annotation.Bean;import org....
Java SSM框架下的校园信息平台：功能全面的登录注册与信息管理
本篇文档介绍了一项Java校园信息发布平台的毕业设计项目，该项目旨在构建一个功能丰富的在线平台，以满足学生和教职员工的信息交流需求。前端技术选用了流行的Vue.js框架与Element-UI相结合，提供了直观且易用的用户...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值