若依接口汇总

一、登录&路由渲染

1.1 登录

1.1.1 登录

请求URL：'/login'
请求方式：POST
传参：loginForm
请求头：isToken（默认传false）

loginForm: {
        username: "admin",
        password: "admin123",
        rememberMe: false,
        code: "",
        uuid: ""
      },

1.1.2 注册

请求URL：'/register'
请求方式：POST
传参：registerForm
请求头：isToken（默认传false）

registerForm: {
        username: "",
        password: "",
        confirmPassword: "",
        code: "",
        uuid: ""
      },

1.1.3 获取验证码

请求URL：'/captchaImage'
请求方式：GET
传参：无
请求头：isToken（默认传false）
超时：20000

1.1.4 获取用户详细信息

请求URL：'/getInfo'
请求方式：GET
传参：无

1.1.5 登出

请求URL：'/logout'
请求方式：POST
传参：token

1.2 路由渲染

1.2.1 获取路由

请求URL：'/getRouters'
请求方式：GET
传参：无

二、系统管理模块

2.1 用户管理

2.1.1 查询用户列表

名称：listUser
请求URL：'/system/user/list'
请求方式：GET
传参：queryParams、dateRange

queryParams: {
        pageNum: 1,
        pageSize: 10,
        userName: undefined,
        phonenumber: undefined,
        status: undefined,
        deptId: undefined
      },

2.1.2 查询用户详细

名称：getUser
请求URL：'/system/user/' + parseStrEmpty(userId)
请求方式：GET
传参：userId

2.1.3 新增用户

名称：addUser
请求URL：'/system/user'
请求方式：POST
传参：form

this.form = {
        userId: undefined,
        deptId: undefined,
        userName: undefined,
        nickName: undefined,
        password: undefined,
        phonenumber: undefined,
        email: undefined,
        sex: undefined,
        status: "0",
        remark: undefined,
        postIds: [],
        roleIds: []
      };

2.1.4 修改用户

名称：updateUser
请求URL：'/system/user'
请求方式：PUT
传参：form（同addUser接口）

this.form = {
        userId: undefined,
        deptId: undefined,
        userName: undefined,
        nickName: undefined,
        password: undefined,
        phonenumber: undefined,
        email: undefined,
        sex: undefined,
        status: "0",
        remark: undefined,
        postIds: [],
        roleIds: []
      };

2.1.5 删除用户

名称：delUser
请求URL：'/system/user/'+ userId
请求方式：DELETE
传参：userId

2.1.6 用户密码重置

名称：resetUserPwd
请求URL：'/system/user/resetPwd'
请求方式：PUT
传参：userId、password

2.1.7 用户状态修改

名称：changeUserStatus
请求URL：'/system/user/changeStatus'
请求方式：PUT
传参：userId、status

2.1.8 查询用户个人信息

名称：getUsetProfile
请求URL：'/system/user/profile'
请求方式：GET
传参：无

2.1.9 修改用户个人信息

名称：updateUserProfile
请求URL：'/system/user/profile'
请求方式：PUT
传参：user (getUserProfile接口的返回结果，res.data）

admin: true
avatar: "/profile/avatar/2022/08/10/blob_20220810105007A010.jpeg"
createBy: "admin"
createTime: "2022-05-18 09:25:24"
delFlag: "0"
dept: Object
deptId: 103
email: "1971679054@qq.com"
loginDate: "2022-08-26T09:15:17.000+08:00"
loginIp: "127.0.0.1"
nickName: "aaaa"
params: Object
phonenumber: "15888888888"
postIds: null
remark: "管理员"
roleId: null
roleIds: null
roles: Array(1)
salt: null
searchValue: null
sex: "1"
status: "0"
updateBy: null
updateTime: null
userId: 1
userName: "admin"

2.1.10 用户密码重置

名称：updateUserPwd
请求URL：'/system/user/profile/updatePwd'
请求方式：PUT
传参：oldPassword、newPassword

2.1.11 用户头像上传

名称：uploadAvatar
请求URL：'/system/user/profile/avatar'
请求方式：POST
传参：avatarfile

2.1.12 查询授权角色

名称：getAuthRole
请求URL：'/system/user/authRole/' + userId
请求方式：GET
传参：userId

2.1.13 保存授权角色

名称：updateAuthRole
请求URL：'/system/user/authRole'
请求方式：PUT
传参：userId、roleIds

{ 
	userId: userId, 
	roleIds: roleIds
}

2.2 角色管理

2.2.1 查询角色列表

名称：listRole
请求URL：'/system/role/list'
请求方式：GET
传参：queryParams、dateRange

// 查询参数
queryParams: {
        pageNum: 1,
        pageSize: 10,
        roleName: undefined,
        roleKey: undefined,
        status: undefined
      },
// 日期范围
dateRange: [],

2.2.2 查询角色详细

名称：getRole
请求URL：'/system/role/' + roleId
请求方式：GET
传参：roleId

2.2.3 新增角色

名称：addRole
请求URL：'/system/role/'
请求方式：POST
传参：form

// 表单参数
this.form = {
        roleId: undefined,
        roleName: undefined,
        roleKey: undefined,
        roleSort: 0,
        status: "0",
        menuIds: [],
        deptIds: [],
        menuCheckStrictly: true,
        deptCheckStrictly: true,
        remark: undefined
      };

2.2.4 修改角色

名称：updateRole
请求URL：'/system/role'
请求方式：PUT
传参：form

// 表单参数
this.form = {
        roleId: undefined,
        roleName: undefined,
        roleKey: undefined,
        roleSort: 0,
        status: "0",
        menuIds: [],
        deptIds: [],
        menuCheckStrictly: true,
        deptCheckStrictly: true,
        remark: undefined
      };

2.2.5 角色数据权限

名称：dataScope
请求URL：'/system/role/dataScope'
请求方式：PUT
传参：form

// 表单参数
this.form = {
        roleId: undefined,
        roleName: undefined,
        roleKey: undefined,
        roleSort: 0,
        status: "0",
        menuIds: [],
        deptIds: [],
        menuCheckStrictly: true,
        deptCheckStrictly: true,
        remark: undefined
      };

2.2.6 角色状态修改

名称：changeRoleStatus
请求URL：'/system/role/changeStatus'
请求方式：PUT
传参：roleId、status

2.2.7 删除角色

名称：delRole
请求UPL：'/system/role/' + roleId
请求方式：delete
传参：roleId

2.2.8 查询角色已授权用户列表

名称：allocatedUserList
请求URL：/system/role/authUser/allocatedList'
请求方式：GET
传参：queryParams

// 查询参数
      queryParams: {
        pageNum: 1,
        pageSize: 10,
        roleId: undefined,
        userName: undefined,
        phonenumber: undefined
      }

2.2.9 查询角色未授权用户列表

名称：unallocatedUserList
请求URL：'/system/role/authUser/unallocatedList'
请求方式：GET
传参：queryParams

// 查询参数
      queryParams: {
        pageNum: 1,
        pageSize: 10,
        roleId: undefined,
        userName: undefined,
        phonenumber: undefined
      }

2.2.10 取消用户授权角色

名称：authUserCancel
请求URL：'/system/role/authUser/cancel'
请求方式：PUT
传参：userId、roleId

{ 
	userId: row.userId, 
	roleId: roleId
}

2.2.11 批量取消用户授权角色

名称：authUserCancelAll
请求URL：'/system/role/authUser/cancelAll'
请求方式：PUT
传参：roleId、userIds

{ 
	roleId: roleId, 
	userIds: userIds 
}

2.2.12 授权用户选择

名称：authUserSelectAll
请求URL：'/system/role/authUser/selectAll'
请求方式：PUT
传参：roleId、userIds

{ 
	roleId: roleId, 
	userIds: userIds 
}

2.3 菜单管理

2.3.1 查询菜单列表

名称： listMenu
请求URL：'/system/menu/list'
请求方式：GET
传参：queryParams（可选）

// 查询参数
queryParams: {
  menuName: undefined,
  visible: undefined
},

2.3.2 查询菜单详细

名称: getMenu
请求方式: GET
请求URL: '/system/menu/' + menuId
传参: menuId

2.3.3 查询菜单下拉树结构

名称: treeselect
请求方式: GET
请求URL: '/system/menu/treeselect'
传参: 无

2.3.4 根据角色ID查询菜单下拉树结构

名称: roleMenuTreeselect
请求方式: GET
请求URL: '/system/menu/roleMenuTreeselect/' + roleId
传参: roleId

2.3.5 新增菜单

名称: addMenu
请求方式: POST
请求URL: '/system/menu'
传参: form

this.form = {
        menuId: undefined,
        parentId: 0,
        menuName: undefined,
        icon: undefined,
        menuType: "M",
        orderNum: undefined,
        isFrame: "1",
        isCache: "0",
        visible: "0",
        status: "0"
      };

2.3.6 修改菜单

名称: updateMenu
请求方式: PUT
请求URL: '/system/menu'
传参: form

this.form = {
        menuId: undefined,
        parentId: 0,
        menuName: undefined,
        icon: undefined,
        menuType: "M",
        orderNum: undefined,
        isFrame: "1",
        isCache: "0",
        visible: "0",
        status: "0"
      };

2.3.7 删除菜单

名称: delMenu
请求方式: DELETE
请求URL: '/system/menu/' + menuId
传参: menuId

2.4 部门管理

2.4.1 查询部门列表

名称: listDept
请求方式: GET
请求URL: '/system/dept/list'
传参: queryParams

// 查询参数
      queryParams: {
        deptName: undefined,
        status: undefined
      },

2.4.2 查询部门详细

名称: listDept
请求方式: GET
请求URL: '/system/dept/' + deptId
传参: deptId

2.4.3 新增部门

名称: addDept
请求方式: POST
请求URL: '/system/dept'
传参: form

this.form = {
        deptId: undefined,
        parentId: undefined,
        deptName: undefined,
        orderNum: undefined,
        leader: undefined,
        phone: undefined,
        email: undefined,
        status: "0"
      };

2.4.4 修改部门

名称: updateDept
请求方式: PUT
请求URL: '/system/dept'
传参: form

this.form = {
        deptId: undefined,
        parentId: undefined,
        deptName: undefined,
        orderNum: undefined,
        leader: undefined,
        phone: undefined,
        email: undefined,
        status: "0"
      };

2.4.5 删除部门

名称: delDept
请求方式: DELETE
请求URL: '/system/dept/' + deptId
传参: deptId

2.4.6 查询部门列表（排除节点）

名称: delDept
请求方式: GET
请求URL: '/system/dept/list/exclude' + deptId
传参: deptId

2.5 岗位管理

2.5.1 查询岗位列表

名称: listPost
请求方式: GET
请求URL: '/system/post/list'
传参: queryParams

// 查询参数
      queryParams: {
        pageNum: 1,
        pageSize: 10,
        postCode: undefined,
        postName: undefined,
        status: undefined
      },

2.5.2 查询岗位详细

名称: getPost
请求方式: GET
请求URL: '/system/post/' + postId
传参: postId

2.5.3 新增岗位

名称: addPost
请求方式: POST
请求URL: '/system/post'
传参: this.form 

this.form = {
        postId: undefined,
        postCode: undefined,
        postName: undefined,
        postSort: 0,
        status: "0",
        remark: undefined
      };

2.5.4 修改岗位

名称: updatePost
请求方式: PUT
请求URL: '/system/post'
传参: this.form 

this.form = {
        postId: undefined,
        postCode: undefined,
        postName: undefined,
        postSort: 0,
        status: "0",
        remark: undefined
      };

2.5.5 删除岗位

名称: delPost
请求方式: DELETE
请求URL: '/system/post' + postId
传参: postId

2.6 字典管理

2.6.1 查询字典类型

名称: listType
请求方式: GET
请求URL: '/system/dict/type/list'
传参: this.addDateRange(this.queryParams, this.dateRange)

// 查询参数
      queryParams: {
        pageNum: 1,
        pageSize: 10,
        dictName: undefined,
        dictType: undefined,
        status: undefined
      },

2.6.2 查询字典类型详细

名称: getType
请求方式: GET
请求URL: '/system/dict/type/' + dictId
传参: dictId

2.6.3 新增字典类型

名称: addType
请求方式: POST
请求URL: '/system/dict/type'
传参: this.form

this.form = {
        dictId: undefined,
        dictName: undefined,
        dictType: undefined,
        status: "0",
        remark: undefined
      };

2.6.4 修改字典类型

名称: updateType
请求方式: PUT
请求URL: '/system/dict/type'
传参: dictId

this.form = {
        dictId: undefined,
        dictName: undefined,
        dictType: undefined,
        status: "0",
        remark: undefined
      };

2.6.5 删除字典类型

名称: delType
请求方式: DELETE
请求URL: '/system/dict/type' + dictId
传参: dictId

2.6.6 刷新字典缓存

名称: refreshCache
请求方式: DELETE
请求URL: '/system/dict/type/refreshCache'

2.6.7 查询字典数据列表

名称: listData
请求方式: GET
请求URL: '/system/dict/data/list'
传参: this.queryParams

// 查询参数
      queryParams: {
        pageNum: 1,
        pageSize: 10,
        dictName: undefined,
        dictType: undefined,
        status: undefined
      },

2.6.8 查询字典数据详细

名称: getData
请求方式: GET
请求URL: '/system/dict/data/' + dictCode
传参: dictCode

2.6.9 查询字典数据详细

名称: getDicts
请求方式: GET
请求URL: '/system/dict/data/type/' + dictType
传参: dictType

2.6.10 新增字典数据

名称: addData
请求方式: POST
请求URL: '/system/dict/data'
传参: this.form

this.form = {
        dictCode: undefined,
        dictLabel: undefined,
        dictValue: undefined,
        cssClass: undefined,
        listClass: 'default',
        dictSort: 0,
        status: "0",
        remark: undefined
      };

2.6.11 修改字典数据

名称: updateData
请求方式: PUT
请求URL: '/system/dict/data'
传参: this.form

this.form = {
        dictCode: undefined,
        dictLabel: undefined,
        dictValue: undefined,
        cssClass: undefined,
        listClass: 'default',
        dictSort: 0,
        status: "0",
        remark: undefined
      };

2.6.12 删除字典数据

名称: delData
请求方式: DELETE
请求URL: '/system/dict/data' + dictCode
传参: dictCode

2.7 参数设置

2.7.1 查询参数列表

名称: listConfig
请求方式: GET
请求URL: '/system/config/list'
传参: this.addDateRange(this.queryParams, this.dateRange)

// 查询参数
      queryParams: {
        pageNum: 1,
        pageSize: 10,
        configName: undefined,
        configKey: undefined,
        configType: undefined
      },

2.7.2 查询参数列表详细

名称: getConfig
请求方式: GET
请求URL: '/system/config/' + configId
传参: configId

2.7.3 根据参数键名查询参数值

名称: getConfigKey
请求方式: GET
请求URL: '/system/config/configKey/' + configKey
传参: configKey

2.7.4 新增参数配置

名称: addConfig
请求方式: POST
请求URL: '/system/config'
传参: this.form

this.form = {
        configId: undefined,
        configName: undefined,
        configKey: undefined,
        configValue: undefined,
        configType: "Y",
        remark: undefined
      };

2.7.5 修改参数配置

名称: updateConfig
请求方式: PUT
请求URL: '/system/config'
传参: this.form

this.form = {
        configId: undefined,
        configName: undefined,
        configKey: undefined,
        configValue: undefined,
        configType: "Y",
        remark: undefined
      };

2.7.6 删除参数配置

名称: delConfig
请求方式: DELETE
请求URL: '/system/config/' + configId
传参: configId

2.7.6 刷新参数缓存

名称: refreshCache
请求方式: DELETE
请求URL: '/system/config/refreshCache'

2.8 通知公告

2.9 日志管理

三、系统监控模块

四、系统工具模块

# 学习 # 前端
Logo
欢迎使用若依开源

快速构建 Web 应用程序

更多推荐

eclipse安装若依框架

1、首先下载maven，下载地址为：http://maven.apache.org/download.cgi，然后选择apache-maven-3.6.0-bin.tar.gz，如下图所示：2、然后新建一个maven目录，如下图所示：3、将下载的maven包解压到该目录中，（注意此时maven的位置，与压缩包的位置相同）如下图所示：4、配置环境变量，新建一个MAVEN_HOME，值为：D:\...

avatar RuoYi 若依

开源框架若依实战Demo学习笔记

若依是个不错的框架，下面是我用他写的一个简单demo，以后会在此基础上进行进一步的开发，下面是整合的过程。我在整合的过程中可谓是一波三折，大家如果不想走弯路，那么这篇文章将对你很有帮助。首先，项目代码地址写列出来，方便大家下载使用，这是整理后的代码https://gitee.com/schjava/heros_separ.git启动项目访问localhost（默认80端口）配置测试用户先创建角色为

avatar RuoYi 若依
cover

docker compose完成简单项目部署

avatar RuoYi 若依