Appearance
系统管理 内部 API
用户、角色、菜单、部门、字典、通知公告、参数等系统管理接口。
权限码为接口所需权限标识。
WorkTaskController
- 基础路径:
/system/task - 类级权限:
@ss.hasPermi('system:task:list')
| 方法 | 路径 | 权限 | 说明 |
|---|---|---|---|
| GET | /system/task/list | @ss.hasPermi('system:task:list') | 查询工作事项列表 |
| POST | /system/task/export | @ss.hasPermi('system:task:export') | 导出工作事项列表 |
| GET | /system/task/{id} | @ss.hasPermi('system:task:query') | 获取工作事项详细信息 |
| POST | /system/task | @ss.hasPermi('system:task:add') | 新增工作事项 |
| PUT | /system/task | @ss.hasPermi('system:task:edit') | 修改工作事项 |
| DELETE | /system/task/{ids} | @ss.hasPermi('system:task:remove') | 删除工作事项 |
SysConfigAssetController
- 基础路径:
/system/config/asset - 类级权限:
@ss.hasPermi('system:config:edit')
| 方法 | 路径 | 权限 | 说明 |
|---|---|---|---|
| POST | /system/config/asset/upload | @ss.hasPermi('system:config:edit') | 上传素材图片(限图片格式;上传成功后返回素材记录,前端直接选用为参数值) |
| GET | /system/config/asset/list | @ss.hasPermi('system:config:list') | 素材库列表(按参数键名过滤;支持文件名关键词,分页) |
| DELETE | /system/config/asset/{assetIds} | @ss.hasPermi('system:config:remove') | 删除素材(使用中的素材不允许删除;删除同时清理站内物理文件) |
SysConfigController
- 基础路径:
/system/config - 类级权限:
@ss.hasPermi('system:config:list')
| 方法 | 路径 | 权限 | 说明 |
|---|---|---|---|
| GET | /system/config/list | @ss.hasPermi('system:config:list') | 获取参数配置列表 |
| POST | /system/config/export | @ss.hasPermi('system:config:export') | |
| GET | /system/config/{configId} | @ss.hasPermi('system:config:query') | 根据参数编号获取详细信息 |
| GET | /system/config/configKey/{configKey} | @ss.hasPermi('system:config:query') | 根据参数键名查询参数值 |
| GET | /system/config/loginBg | 获取登录页背景图配置(匿名访问,供未登录的登录页使用) | |
| GET | /system/config/lockBg | 获取锁屏页背景图配置(匿名访问:锁屏页刷新后可能在不带 token 的形态下渲染) | |
| GET | /system/config/sysInfo | 获取系统信息(名称/副标题/版权/Logo 与登录页外观预设,匿名访问,供框架/Loading页/登录页等未登录场景使用) | |
| GET | /system/config/registerEnabled | 获取注册开关配置(匿名访问,供未登录的登录页决定是否显示"立即注册") | |
| POST | /system/config | @ss.hasPermi('system:config:add') | 新增参数配置 |
| PUT | /system/config | @ss.hasPermi('system:config:edit') | 修改参数配置 |
| DELETE | /system/config/{configIds} | @ss.hasPermi('system:config:remove') | 删除参数配置 |
| DELETE | /system/config/refreshCache | @ss.hasPermi('system:config:remove') | 刷新参数缓存 |
SysDeptController
- 基础路径:
/system/dept - 类级权限:
@ss.hasPermi('system:dept:list')
| 方法 | 路径 | 权限 | 说明 |
|---|---|---|---|
| GET | /system/dept/list | @ss.hasPermi('system:dept:list') | 获取部门列表 |
| GET | /system/dept/list/exclude/{deptId} | @ss.hasPermi('system:dept:list') | 查询部门列表(排除节点) |
| GET | /system/dept/{deptId} | @ss.hasPermi('system:dept:query') | 根据部门编号获取详细信息 |
| POST | /system/dept | @ss.hasPermi('system:dept:add') | 新增部门 |
| PUT | /system/dept | @ss.hasPermi('system:dept:edit') | 修改部门 |
| PUT | /system/dept/updateSort | @ss.hasPermi('system:dept:edit') | 保存部门排序 |
| DELETE | /system/dept/{deptId} | @ss.hasPermi('system:dept:remove') | 删除部门 |
SysDictDataController
- 基础路径:
/system/dict/data - 类级权限:
@ss.hasPermi('system:dict:list')
| 方法 | 路径 | 权限 | 说明 |
|---|---|---|---|
| GET | /system/dict/data/list | @ss.hasPermi('system:dict:list') | 数据字典信息 |
| POST | /system/dict/data/export | @ss.hasPermi('system:dict:export') | |
| GET | /system/dict/data/{dictCode} | @ss.hasPermi('system:dict:query') | 查询字典数据详细 |
| GET | /system/dict/data/type/{dictType} | @ss.hasPermi('system:dict:query') | 根据字典类型查询字典数据信息 |
| POST | /system/dict/data | @ss.hasPermi('system:dict:add') | 新增字典类型 |
| PUT | /system/dict/data | @ss.hasPermi('system:dict:edit') | 修改保存字典类型 |
| DELETE | /system/dict/data/{dictCodes} | @ss.hasPermi('system:dict:remove') | 删除字典类型 |
SysDictTypeController
- 基础路径:
/system/dict/type - 类级权限:
@ss.hasPermi('system:dict:list')
| 方法 | 路径 | 权限 | 说明 |
|---|---|---|---|
| GET | /system/dict/type/list | @ss.hasPermi('system:dict:list') | 数据字典信息 |
| POST | /system/dict/type/export | @ss.hasPermi('system:dict:export') | |
| GET | /system/dict/type/{dictId} | @ss.hasPermi('system:dict:query') | 查询字典类型详细 |
| POST | /system/dict/type | @ss.hasPermi('system:dict:add') | 新增字典类型 |
| PUT | /system/dict/type | @ss.hasPermi('system:dict:edit') | 修改字典类型 |
| DELETE | /system/dict/type/{dictIds} | @ss.hasPermi('system:dict:remove') | 删除字典类型 |
| DELETE | /system/dict/type/refreshCache | @ss.hasPermi('system:dict:remove') | 刷新字典缓存 |
| GET | /system/dict/type/optionselect | @ss.hasPermi('system:dict:remove') | 获取字典选择框列表 |
SysMenuController
- 基础路径:
/system/menu - 类级权限:
@ss.hasPermi('system:menu:list')
| 方法 | 路径 | 权限 | 说明 |
|---|---|---|---|
| GET | /system/menu/list | @ss.hasPermi('system:menu:list') | 获取菜单列表 |
| GET | /system/menu/{menuId} | @ss.hasPermi('system:menu:query') | 根据菜单编号获取详细信息 |
| GET | /system/menu/treeselect | @ss.hasPermi('system:menu:query') | 获取菜单下拉树列表 |
| GET | /system/menu/roleMenuTreeselect/{roleId} | 加载对应角色菜单列表树 | |
| POST | /system/menu | @ss.hasPermi('system:menu:add') | 新增菜单 |
| PUT | /system/menu | @ss.hasPermi('system:menu:edit') | 修改菜单 |
| PUT | /system/menu/updateSort | @ss.hasPermi('system:menu:edit') | 保存菜单排序 |
| DELETE | /system/menu/{menuId} | @ss.hasPermi('system:menu:remove') | 删除菜单 |
SysNoticeController
- 基础路径:
/system/notice - 类级权限:
@ss.hasPermi('system:notice:list')
| 方法 | 路径 | 权限 | 说明 |
|---|---|---|---|
| GET | /system/notice/list | @ss.hasPermi('system:notice:list') | 获取通知公告列表 |
| GET | /system/notice/{noticeId} | @ss.hasPermi('system:notice:list') | 根据通知公告编号获取详细信息 |
| POST | /system/notice | @ss.hasPermi('system:notice:add') | 新增通知公告 |
| PUT | /system/notice | @ss.hasPermi('system:notice:edit') | 修改通知公告 |
| GET | /system/notice/listTop | 首页顶部公告列表(返回全部正常公告,带当前用户已读标记,最多5条) | |
| GET | /system/notice/myList | 通知历史页:分页查询当前用户可见的通知公告(带已读状态,支持标题/类型/阅读状态筛选) | |
| POST | /system/notice/markRead | 标记公告已读 | |
| POST | /system/notice/markReadAll | 批量标记已读(不传 ids = 将当前用户全部可见未读公告一键标为已读) | |
| GET | /system/notice/readUsers/list | @ss.hasPermi('system:notice:list') | 已读用户列表数据 |
| DELETE | /system/notice/{noticeIds} | @ss.hasPermi('system:notice:remove') | 删除通知公告 |
SysPostController
- 基础路径:
/system/post - 类级权限:
@ss.hasPermi('system:post:list')
| 方法 | 路径 | 权限 | 说明 |
|---|---|---|---|
| GET | /system/post/list | @ss.hasPermi('system:post:list') | 获取岗位列表 |
| POST | /system/post/export | @ss.hasPermi('system:post:export') | |
| GET | /system/post/{postId} | @ss.hasPermi('system:post:query') | 根据岗位编号获取详细信息 |
| POST | /system/post | @ss.hasPermi('system:post:add') | 新增岗位 |
| PUT | /system/post | @ss.hasPermi('system:post:edit') | 修改岗位 |
| DELETE | /system/post/{postIds} | @ss.hasPermi('system:post:remove') | 删除岗位 |
| GET | /system/post/optionselect | @ss.hasPermi('system:post:remove') | 获取岗位选择框列表 |
SysProfileController
- 基础路径:
/system/user/profile
| 方法 | 路径 | 权限 | 说明 |
|---|---|---|---|
| GET | /system/user/profile | 个人信息 | |
| PUT | /system/user/profile | 修改用户 | |
| PUT | /system/user/profile/updatePwd | 重置密码 | |
| POST | /system/user/profile/avatar | 头像上传 |
SysRoleController
- 基础路径:
/system/role - 类级权限:
@ss.hasPermi('system:role:list')
| 方法 | 路径 | 权限 | 说明 |
|---|---|---|---|
| GET | /system/role/list | @ss.hasPermi('system:role:list') | |
| POST | /system/role/export | @ss.hasPermi('system:role:export') | |
| GET | /system/role/defaultNavType | 当前登录用户的 | |
| GET | /system/role/{roleId} | @ss.hasPermi('system:role:query') | 根据角色编号获取详细信息 |
| POST | /system/role | @ss.hasPermi('system:role:add') | 新增角色 |
| PUT | /system/role | @ss.hasPermi('system:role:edit') | 修改保存角色 |
| PUT | /system/role/dataScope | @ss.hasPermi('system:role:edit') | 修改保存数据权限 |
| PUT | /system/role/changeStatus | @ss.hasPermi('system:role:edit') | 状态修改 |
| DELETE | /system/role/{roleIds} | @ss.hasPermi('system:role:remove') | 删除角色 |
| GET | /system/role/optionselect | @ss.hasPermi('system:role:query') | 获取角色选择框列表 |
| GET | /system/role/authUser/allocatedList | @ss.hasPermi('system:role:list') | 查询已分配用户角色列表 |
| GET | /system/role/authUser/unallocatedList | @ss.hasPermi('system:role:list') | 查询未分配用户角色列表 |
| PUT | /system/role/authUser/cancel | @ss.hasPermi('system:role:edit') | 取消授权用户 |
| PUT | /system/role/authUser/cancelAll | @ss.hasPermi('system:role:edit') | 批量取消授权用户 |
| PUT | /system/role/authUser/selectAll | @ss.hasPermi('system:role:edit') | 批量选择用户授权 |
| GET | /system/role/deptTree/{roleId} | @ss.hasPermi('system:role:query') | 获取对应角色部门树列表 |
SysUserController
- 基础路径:
/system/user - 类级权限:
@ss.hasPermi('system:user:list')
| 方法 | 路径 | 权限 | 说明 |
|---|---|---|---|
| GET | /system/user/list | @ss.hasPermi('system:user:list') | 获取用户列表 |
| POST | /system/user/export | @ss.hasPermi('system:user:export') | |
| POST | /system/user/importData | @ss.hasPermi('system:user:import') | |
| POST | /system/user/importTemplate | ||
| GET | /system/user/ | @ss.hasPermi('system:user:query') | 根据用户编号获取详细信息 |
| POST | /system/user | @ss.hasPermi('system:user:add') | 新增用户 |
| PUT | /system/user | @ss.hasPermi('system:user:edit') | 修改用户 |
| DELETE | /system/user/{userIds} | @ss.hasPermi('system:user:remove') | 删除用户 |
| PUT | /system/user/resetPwd | @ss.hasPermi('system:user:resetPwd') | 重置密码 |
| PUT | /system/user/unlock/{userId} | @ss.hasPermi('system:user:unlock') | 解锁账号(仅清除登录锁定与失败计数,不修改密码) |
| PUT | /system/user/changeStatus | @ss.hasPermi('system:user:edit') | 状态修改 |
| GET | /system/user/authRole/{userId} | @ss.hasPermi('system:user:query') | 根据用户编号获取授权角色 |
| PUT | /system/user/authRole | @ss.hasPermi('system:user:edit') | 用户授权角色 |
| GET | /system/user/deptTree | @ss.hasPermi('system:user:list') | 获取部门树列表 |