签入版本

2026-10-25 17:24:27 +08:00
parent 48911cc08f
commit fdbeae092a
1010 changed files with 30682 additions and 95274 deletions
@@ -1,279 +1,74 @@
 # E. API 接口速查表

-:::tip 概述
-本表列出所有 API 路由的完整清单，包含 HTTP 方法、路径和所需权限码。
+:::tip 说明
+按模块速查接口形态。标准 CRUD 按统一模式列出；实际清单以 /api.json 与 /swagger 为准（运行时生成）。
 :::

-## 公开接口
+## 标准模式（多数模块）

-| 方法 | 路径 | 说明 |
-|------|------|------|
-| 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/{模块}/page | sys:{模块}:page |
+| 列表 | GET /api/{模块}/list | sys:{模块}:list |
+| 详情 | GET /api/{模块}/detail/:id | sys:{模块}:detail |
+| 新增 | POST /api/{模块}/add | sys:{模块}:add |
+| 修改 | PUT /api/{模块}/update | sys:{模块}:update |
+| 删除 | DELETE /api/{模块}/delete/:id | sys:{模块}:delete |
+| 批量删除 | DELETE /api/{模块}/batchDelete | sys:{模块}:batchDelete |

-## 首页 / 个人中心
+## 认证与个人中心

-| 方法 | 路径 | 权限码 | 说明 |
-|------|------|--------|------|
-| GET | `/api/index/getUser` | - | 获取当前用户信息 |
-| GET | `/api/index/getMenus` | - | 获取菜单列表 |
-| PUT | `/api/index/updatePassword` | - | 修改密码 |
-| PUT | `/api/index/updateProfile` | - | 修改个人资料 |
+| 接口 | 说明 |
+|---|---|
+| GET /api/captcha | 验证码（公开） |
+| POST /api/login | 登录（公开） |
+| POST /api/oauth2/token | 刷新/兑换（公开） |
+| GET /api/oauth2/check/token | 校验令牌 |
+| DELETE /api/oauth2/remove/:token | 撤销令牌 |
+| GET /api/logout | 登出 |
+| GET /api/index/getUser / getMenus | 当前用户/菜单 |
+| PUT /api/index/updatePassword / updateProfile | 改密/资料 |
+| GET /api/health | 健康检查（公开） |

-## 用户管理
+## 模块域名对照

-| 方法 | 路径 | 权限码 | 说明 |
-|------|------|--------|------|
-| 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 | 导出 |
+| 域 | 路径前缀 |
+|---|---|
+| 组织权限 | /api/user、/api/role、/api/menu、/api/dept、/api/level、/api/position、/api/tenant |
+| 内容 | /api/article、/api/category、/api/notice、/api/link |
+| 数据配置 | /api/dict（字典项 /api/dict/item/*、业务别名 /api/dictionary/*）、/api/param、/api/config（配置项 /api/config/item/*、网站配置 /api/config/web/*）、/api/city |
+| 定时任务 | /api/job（任务日志 /api/job/log/*） |
+| 在线用户 | /api/onlineUser |
+| 日志（特殊前缀） | 操作日志 /api/oper/log/*、登录日志 /api/login/log/*（权限码 sys:operLog:* / sys:loginLog:*） |
+| 监控（单接口） | GET /api/server/info、GET /api/cache/info |
+| 文件 | /api/upload/uploadFile(s)、/api/file/template/* |
+| 工具 | /api/example/*、/api/generator/*（page/preview/generate/batchGenerate） |

-## 角色管理
+## 常用非标准接口

-| 方法 | 路径 | 权限码 | 说明 |
-|------|------|--------|------|
-| 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 | 保存角色菜单 |
+| 接口 | 说明 |
+|---|---|
+| PUT /api/example/status | 单列状态（status 型模块同构） |
+| POST /api/example/import / GET /api/example/export | 导入导出 |
+| PUT /api/user/resetPwd | 重置用户密码 |
+| GET /api/user/document/:id | 用户打印信息 |
+| POST /api/role/menu/save | 保存角色菜单权限 |
+| POST /api/tenant/account | 添加租户账号 |
+| GET /api/tenant/users/:tenantId | 查询租户用户 |
+| GET /api/dict/item/getDictItemList/:code | 字典项快捷查询（登录即可） |
+| GET /api/dict/refreshCache | 刷新字典缓存 |
+| GET /api/job/runOnce/:id、pause/:id、resume/:id | 任务执行/暂停/恢复 |
+| GET /api/onlineUser/forceLogout/:id | 强制下线指定会话 |
+| GET /api/onlineUser/forceLogoutUser/:userId | 踢出用户全部设备 |

-## 菜单管理
+注：用户的角色分配没有独立接口——Add/Update 请求的 `roles` 字段在事务内重写 gin_user_role。

-| 方法 | 路径 | 权限码 | 说明 |
-|------|------|--------|------|
-| 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 | 删除 |
+## 约定提醒

-## 部门管理
+- 请求/响应字段小驼峰；分页 pageNo/pageSize → PageData
+- 信封 0/1/401；Bearer access token
+- 精确清单与 schema：`GET /api.json`

-| 方法 | 路径 | 权限码 | 说明 |
-|------|------|--------|------|
-| 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 | 批量生成 |
+- [8.8 API 接口总览](/zh/api-spec/overview.html)