rxthinkcmf-wiki/RXThinkCMF_Laravel13_NaiveVue/zh/appendix/api-cheatsheet.md

E. API 接口速查表

:::tip 概述 本表列出所有 API 路由的完整清单（自动生成自 routes/api.php 与各控制器 #[Permission] 注解），包含 HTTP 方法、路径和所需权限码。批量删除统一为 DELETE（请求体仍传 ids 数组），其余遵循 REST 习惯。 :::

公开接口（免认证）

定义在 routes/api.php 中间件组外，无需携带 Token：

方法	路径	说明
POST	/api/login	用户登录
POST	/api/refresh	刷新 Token
GET	/api/captcha	获取验证码
POST	/api/oauth2/token	OAuth2 获取令牌
GET	/api/oauth2/check/token	检查令牌有效性

认证接口（auth.jwt + tenant + demo + log.operation）

Auth / Index / Upload

方法	路径	权限码	说明
POST	/api/logout	-	登出
DELETE	/api/oauth2/remove/:token	sys:auth:removeToken	吊销令牌
GET	/api/index/getUser	-	获取当前用户信息
GET	/api/index/getMenus	-	获取菜单列表
PUT	/api/index/updatePassword	-	修改密码
PUT	/api/index/updateProfile	-	修改个人资料
POST	/api/upload/uploadFile	sys:upload:file	上传文件

用户管理（User）

方法	路径	权限码	说明
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	修改用户
DELETE	/api/user/delete/:id	sys:user:delete	删除用户
DELETE	/api/user/batchDelete	sys:user:batchDelete	批量删除
PUT	/api/user/resetPwd	sys:user:resetPwd	重置密码
GET	/api/user/export	sys:user:export	导出用户
POST	/api/user/import	sys:user:import	导入用户

角色管理（Role）

方法	路径	权限码	说明
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	sys:role:getPermission	查询角色菜单权限
POST	/api/role/menu/save	sys:role:savePermission	授权角色菜单

菜单管理（Menu）

方法	路径	权限码	说明
GET	/api/menu/list	sys:menu:list	菜单列表
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	删除菜单

部门管理（Dept）

方法	路径	权限码	说明
GET	/api/dept/list	sys:dept:list	部门列表
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	删除部门

职级 / 岗位（Level / Position）

方法	路径	权限码	说明
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/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	批量删除

字典管理（Dict / DictItem）

方法	路径	权限码	说明
GET	/api/dict/page	sys:dict:page	字典分页
GET	/api/dict/detail/:id	sys:dict:detail	字典详情
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/refreshCache	sys:dict:update	刷新字典缓存
GET	/api/dict/item/page	sys:dict:page	字典项分页
GET	/api/dict/item/detail/:id	sys:dict:detail	字典项详情
POST	/api/dict/item/add	sys:dict:add	添加字典项
PUT	/api/dict/item/update	sys:dict:update	修改字典项
DELETE	/api/dict/item/delete/:id	sys:dict:delete	删除字典项
DELETE	/api/dict/item/batchDelete	sys:dict:batchDelete	批量删除字典项
GET	/api/dict/item/getDictItemList/:code	-	按编码查询字典项（前端下拉数据源）

内容管理（Category / Article / Notice / Link）

方法	路径	权限码	说明
GET	/api/category/list	sys:category:list	分类列表
GET	/api/category/page	sys:category:page	分类分页
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	删除分类
DELETE	/api/category/batchDelete	sys:category:batchDelete	批量删除
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/notice/page	sys:notice:page	通知分页
GET	/api/notice/list	sys: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	删除通知
DELETE	/api/notice/batchDelete	sys:notice:batchDelete	批量删除
GET	/api/link/page	sys:link:page	友链分页
GET	/api/link/list	sys:link:list	友链列表
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	删除友链
DELETE	/api/link/batchDelete	sys:link:batchDelete	批量删除

行政区划（City）

方法	路径	权限码	说明
GET	/api/city/list	sys:city:list	城市列表
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	删除城市
DELETE	/api/city/batchDelete	sys:city:batchDelete	批量删除
GET	/api/city/getCityList/:code	-	按编码取下级
GET	/api/city/getParent/:id	-	取上级
GET	/api/city/findByParentCode	-	按父编码查询

系统配置（Config / ConfigItem / Param）

方法	路径	权限码	说明
GET	/api/config/page	sys:config:page	配置分页
GET	/api/config/list	sys:config:list	配置列表
GET	/api/config/detail/:id	sys:config:detail	配置详情
POST	/api/config/add	sys:config:add	添加配置
PUT	/api/config/update	sys:config:update	修改配置
DELETE	/api/config/delete/:id	sys:config:delete	删除配置
DELETE	/api/config/batchDelete	sys:config:batchDelete	批量删除
GET	/api/config/web/index	sys:config:webIndex	查询网站配置
POST	/api/config/web/save	sys:config:update	保存网站配置
GET	/api/config/item/page	sys:config:page	配置项分页
GET	/api/config/item/list	sys:config:list	配置项列表
GET	/api/config/item/detail/:id	sys:config:detail	配置项详情
POST	/api/config/item/add	sys:config:add	添加配置项
PUT	/api/config/item/update	sys:config:update	修改配置项
DELETE	/api/config/item/delete/:id	sys:config:delete	删除配置项
DELETE	/api/config/item/batchDelete	sys:config:batchDelete	批量删除配置项
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	删除参数
DELETE	/api/param/batchDelete	sys:param:batchDelete	批量删除

租户管理（Tenant）

方法	路径	权限码	说明
GET	/api/tenant/page	sys:tenant:page	租户分页
GET	/api/tenant/list	sys:tenant:list	租户列表
GET	/api/tenant/detail/:id	sys:tenant:detail	租户详情
POST	/api/tenant/add	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/tenant/users/:tenantId	sys:tenant:users	租户用户
POST	/api/tenant/account	sys:tenant:createAccount	创建管理员账号

定时任务（Job / JobLog）

方法	路径	权限码	说明
GET	/api/job/page	sys:job:page	任务分页
GET	/api/job/list	sys:job:list	任务列表
GET	/api/job/detail/:id	sys:job:detail	任务详情
POST	/api/job/add	sys:job:add	添加任务
PUT	/api/job/update	sys:job:update	修改任务
DELETE	/api/job/delete/:id	sys:job:delete	删除任务
DELETE	/api/job/batchDelete	sys:job:batchDelete	批量删除
GET	/api/job/runOnce/:id	sys:job:execute	立即执行任务
POST	/api/job/status	sys:job:update	修改任务状态
GET	/api/job/pause/:id	sys:job:pause	暂停任务
GET	/api/job/resume/:id	sys:job:resume	恢复任务
GET	/api/job/daemonStatus	-	守护进程状态
GET	/api/job/log/page	sys:job:page	任务日志分页
GET	/api/job/log/detail/:id	sys:job:detail	任务日志详情
DELETE	/api/job/log/delete/:id	sys:job:delete	删除任务日志
DELETE	/api/job/log/batchDelete	sys:job:batchDelete	批量删除

案例演示（Example）

方法	路径	权限码	说明
GET	/api/example/page	sys:example:page	示例分页
GET	/api/example/list	sys:example:list	示例列表
GET	/api/example/detail/:id	sys:example:detail	示例详情
POST	/api/example/add	sys:example:add	添加示例
PUT	/api/example/update	sys:example:update	修改示例
DELETE	/api/example/delete/:id	sys:example:delete	删除示例
DELETE	/api/example/batchDelete	sys:example:batchDelete	批量删除
GET	/api/example/export	sys:example:export	导出示例
POST	/api/example/import	sys:example:import	导入示例

文件模板（FileTemplate）

方法	路径	权限码	说明
GET	/api/file/template/page	sys:fileTemplate:page	模板分页
GET	/api/file/template/detail/:id	sys:fileTemplate:detail	模板详情
POST	/api/file/template/add	sys:fileTemplate:add	添加模板
PUT	/api/file/template/update	sys:fileTemplate:update	修改模板
DELETE	/api/file/template/delete/:id	sys:fileTemplate:delete	删除模板
DELETE	/api/file/template/batchDelete	sys:fileTemplate:batchDelete	批量删除
GET	/api/file/template/getTemplateByCode/:code	-	按编码取模板（导入模板下载）

代码生成（Generator）

方法	路径	权限码	说明
GET	/api/generator/page	sys:generator:page	数据表分页
GET	/api/generator/preview	sys:generator:generate	预览生成代码
POST	/api/generator/generate	sys:generator:generate	一键生成
POST	/api/generator/batchGenerate	sys:generator:generate	批量生成

日志查询（LoginLog / OperLog）

方法	路径	权限码	说明
GET	/api/login/log/page	sys:loginLog:page	登录日志分页
GET	/api/login/log/detail/:id	sys:loginLog:detail	登录日志详情
DELETE	/api/login/log/delete/:id	sys:loginLog:delete	删除登录日志
DELETE	/api/login/log/batchDelete	sys:loginLog:batchDelete	批量删除
GET	/api/oper/log/page	sys:operLog:page	操作日志分页
GET	/api/oper/log/detail/:id	sys:operLog:detail	操作日志详情
DELETE	/api/oper/log/delete/:id	sys:operLog:delete	删除操作日志
DELETE	/api/oper/log/batchDelete	sys:operLog:batchDelete	批量删除

:::info 说明

• 权限码取自控制器方法的 #[Permission] 注解；- 表示该接口仅需登录（无独立权限码）
• 任务日志（jobLog）复用 sys:job:* 权限码
• 字典项 / 模板 / 行政区划的 getDictItemList、getTemplateByCode、getCityList 等读取接口免独立权限，登录即可访问
• 路径中 :id 为路径参数；查询参数、请求体规范见 8. 接口规范与对接 :::