ssm分页和模糊查询_SSM 单体框架 教育平台后台管理系统：接口文档

最新推荐文章于 2021-12-25 13:40:03 发布
最新推荐文章于 2021-12-25 13:40:03 发布
阅读量199 收藏 1
点赞数
文章标签： ssm分页和模糊查询 ssm框架app管理平台 web接口响应时间标准

04d6e2417641da50882ae3a21c85299a.png

项目接口文档

1.课程模块

1.1 查询 & 条件查询

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

请求方式: POST

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

请求参数:

参数名称是否必须数据类型
currentPagefalseinteger(int32)
pageSizefalseinteger(int32)
courseNamefalsestring
statusfalseinteger(int32)

请求示例:

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

响应参数:

参数名称类型
successboolean
stateinteger(int32)
messagestring
contentobject

响应示例:

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

1.2 图片上传接口

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

请求方式: POST

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

请求参数:

file=1597112871741.JPG

响应参数:

参数名称类型
successboolean
stateinteger(int32)
messagestring
contentobject

响应示例:

{
    "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课程idint否添加操作不携带 ID，修改操作必须携带 ID
courseName课程名称String是
brief课程简介String是一句话介绍课程
teacherName讲师名称String是
description讲师介绍String是
position讲师职位String是
previewFirstField课程概述1String是第一段描述 例如: 课程共15讲
previewSecondField课程概述2String是第二段描述 例如: 每周五更新
discounts售卖价格double是课程的售卖价格
price商品原价double是课程的原销售价
discountsTag活动标签String是例如: 立即抢购
courseImgUrl课程图片urlString是
courseListImg封面图urlString是
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
}

响应参数:

参数名称类型
successboolean
stateinteger(int32)
messagestring
contentobject

响应示例

{
    "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课程idint是

  • 响应结果示例

{
    "success": true,
    "state": 200,
    "message": "响应成功",
    "content": 课程信息以及关联的讲师信息
}

1.5 课程状态管理

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

请求方式: GET

接口描述: 修改课程状态

请求参数:

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

请求示例:

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

响应参数:

参数名称类型
successboolean
stateinteger(int32)
messagestring
contentobject

响应示例:

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

1.6 课程内容展示

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

请求方式: GET

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

请求参数:

参数名称参数说明是否必须数据类型
courseId课程idtrueint

  • 请求示例

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,
                    "createTime": null,
                    "updateTime": null,
                    "isDel": 0,
                    "orderNum": 2,
                    "status": 2
                }
            ]
        }
    ]
}

1.7 回显章节对应的课程信息

  • 名称: findCourseByCourseId

  • 描述:  回显章节对应的课程信息

  • URL: http://localhost:8080/ssm_web/courseContent/findCourseByCourseId

  • 请求方式: GET

  • 请求参数

参数名称参数说明是否必须数据类型
courseId课程idtrueint

  • 请求示例

http://localhost:8080/ssm_web/courseContent/findCourseByCourseId?courseId=15

  • 响应结果示例

{
    "success": true,
    "state": 200,
    "message": "响应成功",
    "content": {
        "id": 15,
        "courseName": "全栈工程师",
    }
}

1.8 新建 & 修改章节信息

  • 名称: saveOrUpdateSection

  • 描述: 保存和修改章节信息

  • URL: http://localhost:8080/ssm_web/courseContent/saveOrUpdateSection

  • 请求方式: POST

  • 请求参数

字段说明类型是否必需备注
id章节IDint否添加操作不携带 ID，修改操作必须携带 ID
course_id课程IDint是
section_name章节名称String是
description章节描述String是
order_num章节排序int是

  • 请求参数示例

// 新增
{
    "courseId": 8,
    "sectionName": "Vue脚手架",
    "description": "快速搭建Vue项目",
    "orderNum": 2
}

// 修改
{
    "id": 22,
    "sectionName": "Vue路由",
    "description": "单页面应用导航",
    "orderNum": 0
}

  • 响应结果示例

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

1.9 修改章节状态

  • 名称: updateSectionStatus

  • 描述: 修改章节状态

  • URL: http://localhost:8080/ssm_web/courseContent/updateSectionStatus

  • 请求方式: GET

  • 请求参数

字段说明类型是否必需备注
id章节IDint是
status章节状态int是状态：0 - 隐藏，1 - 待更新，2 - 已发布

  • 请求示例

http://localhost:8080/ssm_web/courseContent/updateSectionStatus?id=7&status=1

  • 响应结果示例

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

2.0 新建 & 修改课时信息

  • 名称: saveOrUpdateLesson

  • 描述: 保存和修改课时信息

  • URL: http://localhost:8080/ssm_web/courseContent/saveOrUpdateLesson

  • 请求方式: POST

  • 请求参数

字段说明类型是否必需备注
id课时IDint否添加操作不携带 ID，修改操作必须携带 ID
courseId课程IDint是
sectionId章节IDint是
theme课时名称String是
duration课时时长(分钟)int是
isFree是否免费：0 免费，1 付费int是
orderNum排序字段int是

  • 请求示例

// 新建
{
    "courseId": 7,
    "sectionId": 7,
    "theme": "文案高手养成",
    "duration": 15,
    "isFree": 0,
    "orderNum": 2
}

// 修改
{
    "id": 1,
    "theme": "新主题",
    "duration": 20,
    "isFree": 1,
    "orderNum": 3
}

2.广告模块

2.1 广告位列表查询

接口地址: http://localhost:8080/ssm_web/PromotionSpace/findAllPromotionSpace

请求方式: GET

接口描述: 获取广告位列表数据

请求示例:

http://localhost:8080/ssm_web/PromotionSpace/findAllPromotionSpace

响应参数:

参数名称类型
successboolean
stateinteger(int32)
messagestring
contentobject

响应示例:

{
    "success": true,
    "state": 200,
    "message": "响应成功",
    "content": [{
        "id": 1,
        "name": "首页顶部推荐位",
        "spaceKey": "666",
        "createTime": 1594703011000,
        "updateTime": 1594962801000,
        "isDel": 0
    },
    {
        "id": 2,
        "name": "首页侧边广告位",
        "spaceKey": "888",
        "createTime": 1594703011000,
        "updateTime": 1594957982000,
        "isDel": 0
    },
    ...
}

2.2 添加 & 修改广告位

接口地址: http://localhost:8080/ssm_web/PromotionSpace/saveOrUpdatePromotionSpace

请求方式: POST

接口描述: 添加 & 修改广告位

请求参数:

参数名称参数说明是否必须备注
id广告位ID否修改必须携带ID
name广告位名称是
// 新增
{
    "name": "页面头部广告位"
}

// 更新
{
    "id": 173,
    "name": "页面头部广告位"
}

响应参数:

参数名称类型schema
successboolean
stateinteger(int32)integer(int32)
messagestring
contentobject

响应示例:

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

2.3 回显广告位名称

接口地址: http://localhost:8080/ssm_web/PromotionSpace/findPromotionSpaceById

请求方式: GET

接口描述: 修改操作的回显广告位名称

请求参数:

参数名称参数说明是否必须备注
id广告位ID否修改必须携带ID

响应结果: 

{
    "success": true,
    "state": 200,
    "message": "响应成功",
    "content": {
        "id": 1,
        "name": "首页顶部推荐位",
        "spaceKey": null,
        "createTime": null,
        "updateTime": null,
        "isDel": null
    }
}

2.4 广告分页查询

接口地址:  http://localhost:8080/ssm_web/PromotionAd/findAllPromotionAdByPage

请求方式: GET

接口描述: 分页获取广告列表数据

请求参数:

参数名称参数说明是否必须数据类型
currentPage当前页falseinteger(int32)
pageSize每页显示条数falseinteger(int32)

请求示例:

http://localhost:8080/ssm_web/PromotionAd/findAllPromotionAdByPage?currentPage=1&pageSize=5

**响应结果示例: **

{
    "success": true,
    "state": 200,
    "message": "",
    "content": {
        "pageNum": 1,
        "pageSize": 5,
        "size": 5,
        "orderBy": null,
        "startRow": 1,
        "endRow": 5,
        "total": 20,
        "pages": 4,
        "list": [
            {
                "id": 1074,
                "name": "java高级训练营2期",
                "spaceId": 1,
                "keyword": null,
                "htmlContent": null,
                "text": "Java高级训练营 Java高级训练营 Java高级训练营",
                "link": "https://localhost:8080/upload",
                "startTime": "2020-08-17 03:21:27",
                "endTime": "2020-08-18 09:03:45",
                "createTime": 1594708114000,
                "updateTime": 1597894841000,
                "status": 1,
                "priority": 0,
                "img": "http://localhost:8080/upload/1597634499619.jpg",
                "promotionSpace": {
                    "id": 1,
                    "name": "首页顶部推荐位",
                    "spaceKey": null,
                    "createTime": null,
                    "updateTime": null,
                    "isDel": null
                }
            },
            ...
        ],
        "firstPage": 1,
        "prePage": 0,
        "nextPage": 2,
        "lastPage": 4,
        "isFirstPage": true,
        "isLastPage": false,
        "hasPreviousPage": false,
        "hasNextPage": true,
        "navigatePages": 8,
        "navigatepageNums": [
            1,
            2,
            3,
            4
        ]
    }
}

2.5 图片上传接口

接口地址: http://localhost:8080/ssm_web/PromotionAd/PromotionAdUpload

请求方式: POST

接口描述: 广告模块图片上传

请求参数:

file

响应参数:

参数名称类型
successboolean
stateinteger(int32)
messagestring
contentobject

响应结果示例:

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

2.6 新建 & 修改广告接口

接口地址: http://localhost:8080/ssm_web/PromotionAd/saveOrUpdatePromotionAd

请求方式: POST

接口描述: 新建 & 修改广告接口

请求参数:

字段说明类型是否必需备注
id广告idint否添加操作不携带 ID，修改操作携带 ID
name广告名称String是
spaceId广告位置String否
startTime开始时间Date是
endTime到期时间Date是
status上线/下线int否
img广告图片String否
link广告链接String是
text广告备注String否

请求示例: 

// 新增
{
    "name": "Python高级训练营",
    "img": "http://localhost:8080/upload/1597731135966.jpg",
    "link": "www.xxxx.com",
    "spaceId": 1,
    "startTime": "2020-08-18 06:12:08.000",
    "endTime": "2020-08-19 16:00:00.000",
    "status": 1,
    "text": "大家一起学Python"
}

// 修改
{
    "id": 1094,
    "img": "http://localhost:8080/upload/1597731135965.jpg",
    "link": "www.x.com",
    "name": "Python高级训练营01",
    "status": 0,
    "spaceId": 2,
    "startTime": 1597731128000,
    "endTime": 1597852800000,
    "text": "大家一起学Python1111"
}

2.7 修改回显广告信息接口

接口地址: http://localhost:8080/ssm_web/PromotionAd/findPromotionAdById

请求方式: GET

接口描述: 接收广告 ID，返回广告详细信息

请求参数:

参数名称参数说明是否必须数据类型
id广告idtrueint

请求示例

http://10.1.194.181:8080/ssm_web/PromotionAd/findPromotionAdById?id=1091

响应结果示例 

{
    "success": true,
    "state": 200,
    "message": "根据ID查询广告信息成功",
    "content": {
        "id": 1091,
        "name": "Python高级训练营01",
        "spaceId": 2,
        "keyword": null,
        "htmlContent": null,
        "text": "大家一起学Python1111",
        "link": "www.xxxx.com",
        "startTime": "2020-08-18 06:12:08",
        "endTime": "2020-08-19 16:00:00",
        "createTime": null,
        "updateTime": null,
        "status": 1,
        "priority": null,
        "img": "http://localhost:8080/upload/1597731135966.jpg",
        "promotionSpace": null
    }
}

2.8 广告状态上下线

接口地址: http://localhost:8080/ssm_web/PromotionAd/updatePromotionAdStatus

请求方式: GET

接口描述: 修改广告上下线状态

请求参数:

参数名称参数说明是否必须数据类型
id广告idtrueint
status课程状态trueint

请求参数示例

http://localhost:8080/ssm_web/PromotionAd/updatePromotionAdStatus?id=1074&status=1

响应示例: 

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

3.用户模块

3.1 用户分页 & 条件查询

接口地址:  http://localhost:8080/ssm_web/user/findAllUserByPage

请求方式: POST

接口描述: 分页获取用户数据 & 条件查询用户数据

请求参数:

参数名称参数说明是否必须数据类型备注
currentPage当前页falseinteger(int32)
pageSize每页显示条数falseinteger(int32)
username用户名falseString输入手机号即可
startCreateTime注册起始时间falseDate
endCreateTime注册结束时间falseDate

请求参数示例:

{
    "currentPage": "1",
    "pageSize": "10",
    "endCreateTime": "2020-07-13",
    "startCreateTime": "2020-07-09",
    "username": "15321919577"
}

3.2 用户状态设置

接口地址: http://localhost:8080/ssm_web/user/updateUserStatus

请求方式: GET

接口描述: 修改用户状态

请求参数:

参数名称参数说明in是否必须数据类型备注
id用户id是integer(int32)
status用户状态是String用户状态：ENABLE 能登录，DISABLE 不能登录

请求参数示例:

http://10.1.194.181:8080/ssm_web/user/updateUserStatus?id=100030011&status=ENABLE

响应参数示例:

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

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",
        "name": "超级管理员",
        "description": "后台管理员，初始拥有权限管理功能",
        "createdTime": 1595230889000,
        "updatedTime": 1595230889000,
        "createdBy": "system",
        "updatedBy": "system"
    }
    ......
}
4.1.2 添加 & 修改角色

  • 名称: saveOrUpdateRole

  • 描述: 添加 & 修改角色

  • URL: http://localhost:8080/ssm_web/role/saveOrUpdateRole

  • 请求方式: POST

  • 请求参数

参数名称参数说明是否必须数据类型备注
id角色IDfalseint添加操作无 ID，修改操作携带 ID
name角色名称trueString
code角色编码trueString
description角色描述trueString

  • 请求参数示例

// 添加
{
    "name":"资源管理员",
    "code": "RE_MANAGER",
    "description": "管理资源"
}

// 更新
{
    "id": "6",
    "name": "资源管理员",
    "code": "RE_MANAGER",
    "description": "管理资源"
}

  • 响应参数:

参数名称类型
successboolean
stateinteger(int32)
messagestring
contentobject

  • 响应示例:

{
    "success": true,
    "state": 200,
    "message": "响应成功",
    "content": null
}
4.1.3 分配菜单
接口 1 查询所有菜单列表

  • 名称: findAllMenu

  • 描述: 查询所有菜单列表

  • URL: http://localhost:8080/ssm_web/role/findAllMenu

  • 请求方式: GET

  • 请求参数示例:

http://localhost:8080/ssm_web/role/findAllMenu

  • 响应结果示例

content 内容为前端所需的 JSON 格式菜单数据，方便在树形空间中展示

{
    "success": true,
    "state": 200,
    "message": "查询所有的父子菜单信息成功",
    "content": {
        "parentMenuList": [
            {
                "id": 1,
                "parentId": -1,
                "href": "",
                "icon": "lock",
                "name": "权限管理",
                "description": "管理系统角色、菜单、资源",
                "orderNum": 1,
                "shown": 1,
                "level": 0,
                "createdTime": "2020-07-20 07:41:38",
                "updatedTime": "2020-07-20 07:41:38",
                "createdBy": "system",
                "updatedBy": "system",
                "subMenuList": [
                    {
                        "id": 2,
                        "parentId": 1,
                        "href": "Role",
                        "icon": "lock",
                        "name": "角色列表",
                        "description": "管理系统角色",
                        "orderNum": 1,
                        "shown": 1,
                        "level": 1,
                        "createdTime": "2020-07-20 07:41:38",
                        "updatedTime": "2020-07-20 07:41:38",
                        "createdBy": "system",
                        "updatedBy": "system",
                        "subMenuList": []
                    },
                    ...
                ]
            },
            ...
        ]
    }
}
接口 2  根据角色 ID 查询关联菜单 ID

  • 名称: findMenuByRoleId

  • 描述: 根据角色信息查询关联菜单

  • URL: http://localhost:8080/ssm_web/role/findMenuByRoleId?roleId=4

  • 请求方式: GET

  • 请求示例:

http://10.1.194.181:8080/ssm_web/role/findMenuByRoleId?roleId=4

  • 响应结果示例

content 中的内容为：当前角色关联的菜单 ID

{
    "success": true,
    "state": 200,
    "message": "查询角色关联的菜单信息成功",
    "content": [
        7,
        8,
        9,
        15,
        16,
        17,
        18
    ]
}
接口 3 为角色分配菜单列表

  • 名称: RoleContextMenu

  • 描述: 为角色分配菜单

  • URL: http://localhost:8080/ssm_web/role/RoleContextMenu

  • 请求方式: POST

  • 请求参数:

参数名称参数说明是否必须数据类型
roleId角色idtrueint
menuIdList所选的菜单列表idtrueList

  • 请求参数示例:

{
    "roleId": 8,
    "menuIdList": [
        1,
        2,
        3
    ]
}

  • 响应参数示例:

{
    "success": true,
    "state": 200,
    "message": "为角色分配菜单成功",
    "content": null
}
4.1.4 删除角色

  • 名称: deleteRole

  • 描述: 删除角色

  • URL: http://localhost:8080/ssm_web/role/deleteRole?id=5

  • 请求方式: GET

  • 请求示例

http://localhost:8080/ssm_web/role/deleteRole?id=8

  • 响应示例:

{
    "success": true,
    "state": 200,
    "message": "删除角色成功",
    "content": null
}

4.2 菜单模块

4.2.1 菜单列表查询

  • 名称: findAllMenu

  • 描述: 查询菜单列表

  • URL: http://localhost:8080/ssm_web/menu/findAllMenu

  • 请求方式: GET

  • 请求参数示例

http://localhost:8080/ssm_web/menu/findAllMenu?currentPage=1&pageSize=10

  • 响应结果示例

{
    "success": true,
    "state": 200,
    "message": "查询所有菜单信息成功",
    "content": [
        {
            "id": 1,
            "parentId": -1,
            "href": "",
            "icon": "lock",
            "name": "权限管理",
            "description": "管理系统角色、菜单、资源",
            "orderNum": 1,
            "shown": 1,
            "level": 0,
            "createdTime": "2020-07-20 07:41:38",
            "updatedTime": "2020-07-20 07:41:38",
            "createdBy": "system",
            "updatedBy": "system",
            "subMenuList": null
        },
        ...
    ]
}
4.2.2 查询菜单信息(回显)

  • 名称: findMenuInfoById

  • 描述: 根据菜单 ID 查询菜单信息

  • URL: http://localhost:8080/ssm_web/menu/findMenuInfoById

  • 请求方式: GET

  • 请求参数

参数名称参数说明是否必须数据类型备注
id菜单idtrueint菜单 ID。如果是顶级菜单，则 parent_id 值为 -1

  • 响应结果

参数名称参数说明类型备注
successboolean
stateinteger(int32)
messagestring
contentobject
menuInfo菜单信息Menu修改操作需要回显的菜单信息
parentMenuList菜单列表信息List所有的父子菜单列表信息

  • 响应结果示例

{
    "success": true,
    "state": 200,
    "message": "响应成功",
    "content": {
        "menuInfo": {
            "id": 7,
            "parentId": -1,
            "href": "",
            "icon": "setting",
            "name": "广告管理",
            "description": "广告、广告位管理",
            "orderNum": 4,
            "shown": 1,
            "level": 0,
            "createdTime": 1595230898000,
            "updatedTime": 1595230898000,
            "createdBy": "system",
            "updatedBy": "system",
            "subMenuList": []
        },
        "parentMenuList": [
            {
                "id": 1,
                "parentId": -1,
                "href": "",
                "icon": "lock",
                "name": "权限管理",
                "description": "管理系统角色、菜单、资源",
                "orderNum": 1,
                "shown": 1,
                "level": 0,
                "createdTime": 1595230898000,
                "updatedTime": 1595230898000,
                "createdBy": "system",
                "updatedBy": "system",
                "subMenuList": [
                    {
                        "id": 2,
                        "parentId": 1,
                        "href": "Role",
                        "icon": "lock",
                        "name": "角色列表",
                        "description": "管理系统角色",
                        "orderNum": 1,
                        "shown": 1,
                        "level": 1,
                        "createdTime": 1595230898000,
                        "updatedTime": 1595230898000,
                        "createdBy": "system",
                        "updatedBy": "system",
                        "subMenuList": []
                    },
                    ...
                ]
            },
            ...
        ]
    }
}
4.2.3 添加 & 修改菜单

  • 名称: saveOrUpdateMenu

  • 描述: 保存和修改菜单

  • URL: http://localhost:8080/ssm_web/menu/saveOrUpdateMenu

  • 请求方式: POST

  • 请求参数

参数名称参数说明是否必须数据类型备注
id菜单列表id否int修改操作必须携带 id，插入不需要携带
name菜单名称是string
href菜单路径是string
parentId父菜单id是int
description描述是string
icon菜单图标是string
shown是否展示是int
orderNum排序号是int
level菜单层级,从0开始是int
createdTime创建时间是date
updatedTime更新时间是date
createdBy创建人是string
updatedBy更新人是string

  • 请求示例

// 新增
{
    "description": "设置课程状态",
    "href": "updateStatus",
    "icon": "lock",
    "name": "课程管理状态",
    "orderNum": 3,
    "parentId": 5,
    "shown": 0,
    "level": 0,
    "createdTime": "2020-09-10 20:32:41",
    "updatedTime": "2020-09-10 20:32:41",
    "createdBy": "system",
    "updatedBy": "system"
}

// 修改
{
    "id": 27,
    "description": "设置课程状态修改",
    "href": "updateStatus修改",
    "icon": "lock",
    "name": "课程管理状态修改",
    "orderNum": 3,
    "parentId": 5,
    "shown": 1,
    "level": 1,
    "updatedTime": "2020-09-10 20:32:41",
    "updatedBy": "system"
}

4.3 资源模块

4.3.1 查询资源分类信息

  • 名称: findAllResourceCategory

  • 描述: 查询资源分类信息列表

  • URL: http://localhost:8080/ssm_web/ResourceCategory/findAllResourceCategory

  • 请求方式: GET

  • 请求参数

无

  • 响应结果示例

{
    "success": true,
    "state": 200,
    "message": "响应成功",
    "content": [
        {
            "id": 1,
            "code": "ADMIN",
            "name": "超级管理员",
            "description": "后台管理员，初始拥有权限管理功能",
            "createdTime": 1595230889000,
            "updatedTime": 1595230889000,
            "createdBy": "system",
            "updatedBy": "system"
        },
        ...
    ]
}
4.3.2 资源信息分页 & 条件查询

  • 名称: findAllResource

  • 描述: 资源信息分页 & 条件查询

  • URL: http://localhost:8080/ssm_web/resource/findAllResource

  • 请求方式: POST

  • 请求参数

参数名称参数说明类型
currentPage当前页int
pageSize每页显示条数int
name资源名称string
categoryId资源分类idint
url资源路径string

  • 请求参数示例

{
    "categoryId": 1,
    "currentPage": 1,
    "name": "获取所有角色",
    "pageSize": 5,
    "url": "/boss/role/all"
}

  • 响应结果示例

{
    "success": true,
    "state": 200,
    "message": "",
    "content": {
        "pageNum": 1,
        "pageSize": 5,
        "size": 1,
        "orderBy": null,
        "startRow": 1,
        "endRow": 1,
        "total": 1,
        "pages": 1,
        "list": [
            {
                "id": 1,
                "name": "获取所有角色",
                "url": "/boss/role/all",
                "categoryId": 1,
                "description": "获取所有角色",
                "createdTime": 1595230917000,
                "updatedTime": 1595230917000,
                "createdBy": "system",
                "updatedBy": "system"
            }
        ],
        "firstPage": 1,
        "prePage": 0,
        "nextPage": 0,
        "lastPage": 1,
        "isFirstPage": true,
        "isLastPage": true,
        "hasPreviousPage": false,
        "hasNextPage": false,
        "navigatePages": 8,
        "navigatepageNums": [
            1
        ]
    }
}
4.3.3 添加 & 更新资源信息

  • 名称: saveOrUpdateResource

  • 描述: 添加 & 更新资源信息

  • URL: http://localhost:8080/ssm_web/resource/saveOrUpdateResource

  • 请求方式: POST

  • 请求参数

参数名称参数说明是否必须数据类型备注
id资源idfalseint添加操作无 ID，修改操作携带 ID
name资源名称trueString
url资源路径trueString
categoryId所属资源分类trueInteger
description资源描述trueString

请求示例:

// 添加
{
    "name": "获取所有角色",
    "url": "/boss/role/all",
    "categoryId": "1",
    "description": "获取所有角色"
}

// 更新
{
    "id": "52",
    "name": "获取所有菜单",
    "url": "/boss/menu/all",
    "categoryId": "2",
    "description": "获取所有菜单"
}

响应参数:

参数名称类型
successboolean
stateinteger(int32)
messagestring
contentobject
4.3.4 删除资源信息

  • 名称: deleteResource

  • 描述: 删除资源信息

  • URL: http://localhost:8080/ssm_web/resource/deleteResource?id=5

  • 请求方式: GET

  • 请求示例

http://localhost:8080/ssm_web/resource/deleteResource?id=5

响应参数:

响应参数:

参数名称类型
successboolean
stateinteger(int32)
messagestring
contentobject

5.登录授权

5.1 用户登录

  • 名称: login

  • 描述: 用户登录

  • URL: http://localhost:8080/ssm_web/user/login

  • 请求方式: GET

  • 请求示例

 http://localhost:8080/ssm_web/user/login?phone=13925067232&password=123456

  • 响应结果示例

{
    "success": true,
    "state": 200,
    "message": "登陆成功",
    "content": {
        "access_token": "de5ac75a-c721-477c-bc93-585e45c903ea",
        "user_id": 100030024
    }
}

5.2 分配角色(回显)

  • 名称: findUserRoleById

  • 描述: 获取用户拥有的菜单权限

  • URL: http://localhost:8080/ssm_web/user/findUserRoleById

  • 请求方式: GET

  • 请求示例

http://localhost:8080/ssm_web/user/findUserRoleById?id=100030012

  • 响应结果

参数名称类型
successboolean
stateinteger(int32)
messagestring
contentobject

  • 响应结果示例

{
    "success": true,
    "state": 200,
    "message": "分配角色回显成功",
    "content": [
        {
            "id": 1,
            "code": "ADMIN",
            "name": "超级管理员",
            "description": "后台管理员，初始拥有权限管理功能",
            "createdTime": 1595230889000,
            "updatedTime": 1595230889000,
            "createdBy": "system",
            "updatedBy": "system"
        }
    ]
}

5.3 分配角色

  • 名称: userContextRole

  • 描述: 获取用户拥有的菜单权限

  • URL: http://localhost:8080/ssm_web/user/userContextRole

  • 请求方式: POST

  • 请求示例

{
    "userId": 4,
    "roleIdList": [
        1,
        2,
        3
    ]
}

  • 响应结果

参数名称类型
successboolean
stateinteger(int32)
messagestring
contentobject

  • 响应结果示例

{
    "success": true,
    "state": 200,
    "message": "分配角色成功",
    "content": null
}

5.4 获取用户拥有的权限

  • 名称: getUserPermissions

  • 描述: 获取用户拥有的菜单权限

  • URL: http://localhost:8080/ssm_web/user/getUserPermissions

  • 请求方式: GET

  • 请求示例

先进行登录接口测试，获取 access_token；
然后请求的 Headers 中增加一个 key 为 Authorization，Value 为登录获取的 access_token 的键值对。

  • 响应结果

参数名称类型
successboolean
stateinteger(int32)
messagestring
contentobject

  • 响应结果示例

{
    "success": true,
    "state": 200,
    "message": "获取用户权限信息成功",
    "content": {
        "menuList": [
            {
                "id": 5,
                "parentId": -1,
                "href": "Courses",
                "icon": "film",
                "name": "课程管理",
                "description": "课程的新增、修改、查看、发布、上下架",
                "orderNum": 2,
                "shown": 1,
                "level": 0,
                "createdTime": "2020-07-20 07:41:38",
                "updatedTime": "2020-07-20 07:41:38",
                "createdBy": "system",
                "updatedBy": "system",
                "subMenuList": [
                    {
                        "id": 19,
                        "parentId": 5,
                        "href": "CourseItem",
                        "icon": "setting",
                        "name": "课程详情页面",
                        "description": "课程详情页面路由",
                        "orderNum": 1,
                        "shown": 0,
                        "level": 1,
                        "createdTime": "2020-07-20 07:41:38",
                        "updatedTime": "2020-07-20 07:41:38",
                        "createdBy": "system",
                        "updatedBy": "system",
                        "subMenuList": null
                    },
                    ...
                ]
            },
            ...
        ],
        "resourceList": [
            {
                "id": 1,
                "name": "获取所有角色",
                "url": "/boss/role/all",
                "categoryId": 1,
                "description": "获取所有角色",
                "createdTime": 1595230917000,
                "updatedTime": 1595230917000,
                "createdBy": "system",
                "updatedBy": "system"
            },
            ...
        ]
    }
}
weixin_39748838
关注
ssm分页+模糊查询
lcscy的博客
07-24 2786
继上一篇博客ssm登录+增删改+列表展示数据后，笔者在此文将进行ssm的数据分页以及模糊查询功能。 1.建立页面实体类 在bean包下建立PageInfo类，此类存放关于分页展示数据时关于页面的各种相关参数，如页面中的数据记录List，单个页面数据记录条数上限size，页面总数totalPage,模糊查询时查询到的记录总数totalCount,当前页面位置currentPage, 代码如下： public class PageInfo<T> { private List<T>
SSM 单体框架 - 教育平台后台管理系统：接口文档
qq_40286307的博客
09-18 483
接口文档 1.课程模块 1.1 查询 & 条件查询 接口地址: http://localhost:8080/ssm_web/course/findCourseByCondition 请求方式: POST 接口描述: 分页获取课程列表数据&多条件查询 请求参数: 参数名称 是否必须 数据类型 currentPage false integer(int32) pageSize false integer(int32) courseName false string s
ssm框架分页及模糊查询
04-19
初学ssm框架，网上的分页及模糊查询大多语焉不详，对于初学者来说无法理解，自己通过好几天的查询，写出了一个这么一个简单的东西，希望对大家有点帮助（旧版。不推荐.分页有bug）
ssm框架下模糊查询分页
11-19
本资源适合初学者学习物理分页技术
ssm分页+模糊查询案例（详细）
M动力的博客
04-06 1308
最近在复习ssm框架，做了一套比较全的ssm流程项目，工具采用IDEA maven工程 结构：
SSM框架的分页模糊查询代码(精)
08-18
【学习SSM分页模糊查询必备】 .zip格式，方便Windows和Unix用户 登录页地址：http://localhost:8080/ssm3/user/login 账号密码为数据库中所有用户名和密码(admim 123) tomcat配置文件和jdbc不匹配的请自行修改 环境：基于SSM框架(Spring+SpringMVC+MyBatis) + Mysql数据库 + Tomcat7 功能：登录、首页显示用户名和身份、分页http://u.download.csdn.net/images/btn_submit.png、模糊查询、 页面跳转(首页、上一页、下一页、末页、指定页跳转(用户输入)，第几/几页，总数据行数) 以及跳转页数的溢出判断、非整形正则判断 数据视图的隔行变色和光棒效果
SSM 单体框架 - 教育平台后台管理系统：权限模块开发
qq_40286307的博客
09-21 400
权限概念介绍 权限：权利（能做的）和限制（不能做的），在权限范围内做好自己的事情 认证： 验证用户名密码是否正确的过程 授权： 对用户所能访问的资源进行控制（动态显示菜单、URL 级别的权限控制） 实现权限系统的原因 首先系统需要进行登陆才能访问 其次不同登陆用户要有不同的权利，而且要有不同的菜单（例如财务经理针对系统中财务相关模块进行操作，人事经理针对系统中人事模块进行操作） 权限控制基本原理 ACL（Access Control Lists） ACL 是最早也是最基本的一种访问控制机制，它的原理非常简单
SSM 单体框架 - 前端开发：用户和权限模块
qq_40286307的博客
09-25 428
用户管理 分页 & 条件查询用户数据 查询条件 1. 用户手机号 2. 注册时间,包含开始日期和结束日期 日期选择器组件 在查询条件中使用了 Element UI 中的日期选择器：https://element.eleme.cn/#/zh-CN/component/date-picker#mo-ren-xian-shi-ri-qi 在测试项目中创建一个 TestDate.vue 组件，复制代码到页面 <template> <div> <div class=
SSM_框架简答题
qq_44509920的博客
09-02 1477
文章目录一：StringMVC1、讲一下MVC2、springmvc的执行流程3、什么是Spring MVC框架的控制器？4、SpringMVC跳转一个页面，怎么返回一个json数据?5、分层设计的优缺点6、SpringMVC和Spring的常用注解7、从页面传数据到后台的几种方式，以及后台如何接收8、SpringMVC是怎么处理Http请求的?9、@Controller 注解的作用10、@RequestMapping 注解的作用11、注解开发怎么返回集合数据二：StringCloud1、SpringClo
一二三应用开发平台-企业级通用低代码开发平台V1.0，前后端分离架构，vue3+elementplus+SSM
最新发布
04-28
重度使用MybatisPlus，包括主键策略、逻辑删除、乐观锁、自动填充、数据分页、CURD接口、条件构造器等。 当前版本完成了系统内核部分：组织机构、人员、角色、权限、数据字典、日志；低代码配置模块：模块、实体、...
ssm+maven+三级联动+分页+多条件模糊查询
05-03
ssm+maven+三级联动+分页+多条件模糊查询
SSM项目增删改查以及模糊查询与分页
11-28
SSM项目增删改查以及模糊查询与分页，SSM+ajax+mysql
基于SSM框架的增删改查Ajax分页模糊查询（有Mysql数据库）
06-26
新闻和对新闻的评论的增删改差
基于ssm的登陆注册批量增删该查分页模糊查询
04-19
ssm框架，mysql数据库，ajax，正则验证，分页，模糊查询，弹窗修改，增删改查
ssm分页及模糊查询源码下载
04-21
上一个ssm框架的改进版：去掉了模糊查询非法输入的bug
SSM异步请求分页+模糊查询
皮卡丘的博客
12-25 525
希望各位网友提出更好的建议，本人由于时间原因没有详细介绍，只提出了思路和实现方式，当然也可以用分页插件，我这里只讲述最原始的实现方式
SSM框架之数据分页，模糊查询
qq1570826515的博客
09-10 979
1、创建springMVC项目，搭建环境 2、创建Page.java，存储信息 import java.util.HashMap; import java.util.List; import java.util.Map; public class Page { //显示第几页 private int pageNow = 1; //每页显示条数 private int pageSize =...
SpringBoot2.x系列教程19--Web开发05之XML方式实现SSM整合
一一哥
03-26 887
SpringBoot系列教程19--Web开发05之XML方式实现SSM整合 作者：一一哥 注意： 本系列教程案例继续在之前的基础上进行编写！ Spring Boot可以帮助我们快速搭建一个SSM框架环境,那么该怎么具体实现SSM整合呢? 以下给大家介绍在SpringBoot项目中进行SSM整合的两种方式: 1️⃣. XML方式; 2️⃣. 注解两种方式. 一. 在SpringBoo...
7.23 ssm分页+模糊搜索
qq_43582235的博客
07-26 161
（1）ssm分页 ①UserDao.java注册方法 int getTotalCount(@Param("username")String username); ②UserMapper.xml数据库语句 <select id="getTotalCount" resultType="int"> select count(*)from tb_user <if test="username!=null and username!=''"> where us
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值