279 lines
12 KiB
Markdown
279 lines
12 KiB
Markdown
# E. API 接口速查表
|
|
|
|
:::tip 概述
|
|
本表列出所有 API 路由的完整清单，包含 HTTP 方法、路径和所需权限码。
|
|
:::
|
|
|
|
## 公开接口
|
|
|
|
| 方法 | 路径 | 说明 |
|
|
|------|------|------|
|
|
| POST | `/api/login` | 用户登录 |
|
|
| GET | `/api/logout` | 用户登出 |
|
|
| GET | `/api/captcha` | 获取验证码 |
|
|
| POST | `/api/oauth2/token` | 刷新 Token |
|
|
| DELETE | `/api/oauth2/remove/:token` | 移除 Token |
|
|
| GET | `/api/oauth2/check/token` | 检查 Token |
|
|
|
|
## 首页 / 个人中心
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/index/getUser` | - | 获取当前用户信息 |
|
|
| GET | `/api/index/getMenus` | - | 获取菜单列表 |
|
|
| PUT | `/api/index/updatePassword` | - | 修改密码 |
|
|
| PUT | `/api/index/updateProfile` | - | 修改个人资料 |
|
|
|
|
## 用户管理
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/user/page` | sys:user:page | 分页列表 |
|
|
| GET | `/api/user/detail/:id` | sys:user:detail | 详情 |
|
|
| POST | `/api/user/add` | sys:user:add | 新增 |
|
|
| PUT | `/api/user/update` | sys:user:update | 修改 |
|
|
| PUT | `/api/user/resetPwd` | sys:user:resetPwd | 重置密码 |
|
|
| DELETE | `/api/user/delete/:id` | sys:user:delete | 删除 |
|
|
| DELETE | `/api/user/batchDelete` | sys:user:batchDelete | 批量删除 |
|
|
| POST | `/api/user/import` | sys:user:import | 导入 |
|
|
| GET | `/api/user/export` | sys:user:export | 导出 |
|
|
|
|
## 角色管理
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/role/page` | sys:role:page | 分页列表 |
|
|
| GET | `/api/role/list` | sys:role:list | 全量列表 |
|
|
| GET | `/api/role/detail/:id` | sys:role:detail | 详情 |
|
|
| POST | `/api/role/add` | sys:role:add | 新增 |
|
|
| PUT | `/api/role/update` | sys:role:update | 修改 |
|
|
| DELETE | `/api/role/delete/:id` | sys:role:delete | 删除 |
|
|
| DELETE | `/api/role/batchDelete` | sys:role:batchDelete | 批量删除 |
|
|
| GET | `/api/role/menu/list/:id` | - | 角色菜单列表 |
|
|
| POST | `/api/role/menu/save` | sys:role:authorize | 保存角色菜单 |
|
|
|
|
## 菜单管理
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/menu/list` | sys:menu:page | 菜单列表（树形） |
|
|
| GET | `/api/menu/detail/:id` | sys:menu:detail | 详情 |
|
|
| POST | `/api/menu/add` | sys:menu:add | 新增 |
|
|
| PUT | `/api/menu/update` | sys:menu:update | 修改 |
|
|
| DELETE | `/api/menu/delete/:id` | sys:menu:delete | 删除 |
|
|
|
|
## 部门管理
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/dept/list` | sys:dept:page | 部门列表（树形） |
|
|
| GET | `/api/dept/detail/:id` | sys:dept:detail | 详情 |
|
|
| POST | `/api/dept/add` | sys:dept:add | 新增 |
|
|
| PUT | `/api/dept/update` | sys:dept:update | 修改 |
|
|
| DELETE | `/api/dept/delete/:id` | sys:dept:delete | 删除 |
|
|
|
|
## 岗位管理
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/position/page` | sys:position:page | 分页列表 |
|
|
| GET | `/api/position/list` | sys:position:list | 全量列表 |
|
|
| GET | `/api/position/detail/:id` | sys:position:detail | 详情 |
|
|
| POST | `/api/position/add` | sys:position:add | 新增 |
|
|
| PUT | `/api/position/update` | sys:position:update | 修改 |
|
|
| DELETE | `/api/position/delete/:id` | sys:position:delete | 删除 |
|
|
| DELETE | `/api/position/batchDelete` | sys:position:batchDelete | 批量删除 |
|
|
|
|
## 职级管理
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/level/page` | sys:level:page | 分页列表 |
|
|
| GET | `/api/level/list` | sys:level:list | 全量列表 |
|
|
| GET | `/api/level/detail/:id` | sys:level:detail | 详情 |
|
|
| POST | `/api/level/add` | sys:level:add | 新增 |
|
|
| PUT | `/api/level/update` | sys:level:update | 修改 |
|
|
| DELETE | `/api/level/delete/:id` | sys:level:delete | 删除 |
|
|
| DELETE | `/api/level/batchDelete` | sys:level:batchDelete | 批量删除 |
|
|
| GET | `/api/level/export` | sys:level:export | 导出 |
|
|
| POST | `/api/level/import` | sys:level:import | 导入 |
|
|
|
|
## 数据字典
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/dict/page` | sys:dict:page | 分页列表 |
|
|
| GET | `/api/dict/detail/:id` | sys:dict:detail | 详情 |
|
|
| GET | `/api/dict/refreshCache` | sys:dict:refreshCache | 刷新缓存 |
|
|
| POST | `/api/dict/add` | sys:dict:add | 新增 |
|
|
| PUT | `/api/dict/update` | sys:dict:update | 修改 |
|
|
| DELETE | `/api/dict/delete/:id` | sys:dict:delete | 删除 |
|
|
| DELETE | `/api/dict/batchDelete` | sys:dict:batchDelete | 批量删除 |
|
|
|
|
## 字典项
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/dict/item/page` | sys:dict:item:page | 分页列表 |
|
|
| GET | `/api/dict/item/detail/:id` | sys:dict:item:detail | 详情 |
|
|
| GET | `/api/dict/item/getDictItemList/:code` | - | 按编码获取字典项 |
|
|
| POST | `/api/dict/item/add` | sys:dict:item:add | 新增 |
|
|
| PUT | `/api/dict/item/update` | sys:dict:item:update | 修改 |
|
|
| DELETE | `/api/dict/item/delete/:id` | sys:dict:item:delete | 删除 |
|
|
| DELETE | `/api/dict/item/batchDelete` | sys:dict:item:batchDelete | 批量删除 |
|
|
|
|
## 租户管理
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/tenant/page` | sys:tenant:page | 分页列表 |
|
|
| GET | `/api/tenant/detail/:id` | sys:tenant:detail | 详情 |
|
|
| GET | `/api/tenant/users/:tenantId` | - | 租户用户列表 |
|
|
| POST | `/api/tenant/add` | sys:tenant:add | 新增 |
|
|
| POST | `/api/tenant/account` | sys:tenant:add | 创建租户账号 |
|
|
| PUT | `/api/tenant/update` | sys:tenant:update | 修改 |
|
|
| DELETE | `/api/tenant/delete/:id` | sys:tenant:delete | 删除 |
|
|
| DELETE | `/api/tenant/batchDelete` | sys:tenant:batchDelete | 批量删除 |
|
|
|
|
## 系统配置
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/config/page` | sys:config:page | 分页列表 |
|
|
| GET | `/api/config/list` | sys:config:list | 全量列表 |
|
|
| GET | `/api/config/detail/:id` | sys:config:detail | 详情 |
|
|
| GET | `/api/config/web/index` | sys:config:web | 网站配置 |
|
|
| POST | `/api/config/web/save` | sys:config:web | 保存网站配置 |
|
|
| POST | `/api/config/add` | sys:config:add | 新增 |
|
|
| PUT | `/api/config/update` | sys:config:update | 修改 |
|
|
| DELETE | `/api/config/delete/:id` | sys:config:delete | 删除 |
|
|
|
|
## 配置项
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/config/item/page` | sys:config:item:page | 分页列表 |
|
|
| GET | `/api/config/item/list` | sys:config:item:list | 全量列表 |
|
|
| GET | `/api/config/item/detail/:id` | sys:config:item:detail | 详情 |
|
|
| POST | `/api/config/item/add` | sys:config:item:add | 新增 |
|
|
| PUT | `/api/config/item/update` | sys:config:item:update | 修改 |
|
|
| DELETE | `/api/config/item/delete/:id` | sys:config:item:delete | 删除 |
|
|
|
|
## 系统参数
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/param/page` | sys:param:page | 分页列表 |
|
|
| GET | `/api/param/list` | sys:param:list | 全量列表 |
|
|
| GET | `/api/param/detail/:id` | sys:param:detail | 详情 |
|
|
| POST | `/api/param/add` | sys:param:add | 新增 |
|
|
| PUT | `/api/param/update` | sys:param:update | 修改 |
|
|
| DELETE | `/api/param/delete/:id` | sys:param:delete | 删除 |
|
|
|
|
## 通知公告
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/notice/page` | sys:notice:page | 分页列表 |
|
|
| GET | `/api/notice/list` | - | 全量列表 |
|
|
| GET | `/api/notice/detail/:id` | sys:notice:detail | 详情 |
|
|
| POST | `/api/notice/add` | sys:notice:add | 新增 |
|
|
| PUT | `/api/notice/update` | sys:notice:update | 修改 |
|
|
| DELETE | `/api/notice/delete/:id` | sys:notice:delete | 删除 |
|
|
|
|
## 城市行政区划
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/city/list` | sys:city:page | 城市列表 |
|
|
| GET | `/api/city/detail/:id` | sys:city:detail | 详情 |
|
|
| POST | `/api/city/add` | sys:city:add | 新增 |
|
|
| PUT | `/api/city/update` | sys:city:update | 修改 |
|
|
| DELETE | `/api/city/delete/:id` | sys:city:delete | 删除 |
|
|
| GET | `/api/city/getCityList/:parentCode` | - | 按父编码获取城市 |
|
|
|
|
## 文章管理
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/article/page` | sys:article:page | 分页列表 |
|
|
| GET | `/api/article/list` | sys:article:list | 全量列表 |
|
|
| GET | `/api/article/detail/:id` | sys:article:detail | 详情 |
|
|
| POST | `/api/article/add` | sys:article:add | 新增 |
|
|
| PUT | `/api/article/update` | sys:article:update | 修改 |
|
|
| DELETE | `/api/article/delete/:id` | sys:article:delete | 删除 |
|
|
| DELETE | `/api/article/batchDelete` | sys:article:batchDelete | 批量删除 |
|
|
|
|
## 文章分类
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/category/page` | sys:category:page | 分页列表 |
|
|
| GET | `/api/category/list` | sys:category:list | 全量列表 |
|
|
| GET | `/api/category/detail/:id` | sys:category:detail | 详情 |
|
|
| POST | `/api/category/add` | sys:category:add | 新增 |
|
|
| PUT | `/api/category/update` | sys:category:update | 修改 |
|
|
| DELETE | `/api/category/delete/:id` | sys:category:delete | 删除 |
|
|
|
|
## 友情链接
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/link/page` | sys:link:page | 分页列表 |
|
|
| GET | `/api/link/detail/:id` | sys:link:detail | 详情 |
|
|
| POST | `/api/link/add` | sys:link:add | 新增 |
|
|
| PUT | `/api/link/update` | sys:link:update | 修改 |
|
|
| DELETE | `/api/link/delete/:id` | sys:link:delete | 删除 |
|
|
|
|
## 定时任务
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/job/page` | sys:job:page | 分页列表 |
|
|
| GET | `/api/job/list` | sys:job:list | 全量列表 |
|
|
| GET | `/api/job/detail/:id` | sys:job:detail | 详情 |
|
|
| GET | `/api/job/runOnce/:id` | sys:job:execute | 手动执行一次 |
|
|
| GET | `/api/job/pause/:id` | sys:job:pause | 暂停任务 |
|
|
| GET | `/api/job/resume/:id` | sys:job:resume | 恢复任务 |
|
|
| POST | `/api/job/add` | sys:job:add | 新增 |
|
|
| PUT | `/api/job/update` | sys:job:update | 修改 |
|
|
| DELETE | `/api/job/delete/:id` | sys:job:delete | 删除 |
|
|
|
|
## 任务日志
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/job/log/page` | sys:job:log:page | 分页列表 |
|
|
| GET | `/api/job/log/detail/:id` | sys:job:log:detail | 详情 |
|
|
| DELETE | `/api/job/log/delete/:id` | sys:job:log:delete | 删除 |
|
|
|
|
## 操作日志
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/oper/log/page` | sys:oper:log:page | 分页列表 |
|
|
| GET | `/api/oper/log/detail/:id` | sys:oper:log:detail | 详情 |
|
|
| DELETE | `/api/oper/log/delete/:id` | sys:oper:log:delete | 删除 |
|
|
|
|
## 登录日志
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/login/log/page` | sys:login:log:page | 分页列表 |
|
|
| GET | `/api/login/log/detail/:id` | sys:login:log:detail | 详情 |
|
|
| DELETE | `/api/login/log/delete/:id` | sys:login:log:delete | 删除 |
|
|
|
|
## 文件上传
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| POST | `/api/upload/uploadFile` | - | 上传文件 |
|
|
|
|
## 代码生成器
|
|
|
|
| 方法 | 路径 | 权限码 | 说明 |
|
|
|------|------|--------|------|
|
|
| GET | `/api/generator/page` | sys:generator:page | 可生成表列表 |
|
|
| POST | `/api/generator/preview` | sys:generator:preview | 预览生成代码 |
|
|
| POST | `/api/generator/generate` | sys:generator:generate | 生成代码 |
|
|
| POST | `/api/generator/batchGenerate` | sys:generator:generate | 批量生成 | |