import{_ as d,o as e,c as a,a2 as o}from"./chunks/framework.B-QBKwc1.js";const y=JSON.parse('{"title":"API 接口速查表","description":"本表列出所有 API 路由的完整清单(自动生成自 routes/api.php 与各控制器 #[Permission] 注解),包含 HTTP 方法、路径和所需权限码。","frontmatter":{},"headers":[],"relativePath":"zh/appendix/api-cheatsheet.md","filePath":"zh/appendix/api-cheatsheet.md"}'),i={name:"zh/appendix/api-cheatsheet.md"};function r(c,t,s,l,p,h){return e(),a("div",null,[...t[0]||(t[0]=[o('

E. API 接口速查表 ​

概述

本表列出所有 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/tokenOAuth2 获取令牌
GET/api/oauth2/check/token检查令牌有效性

认证接口(auth.jwt + tenant + demo + log.operation) ​

Auth / Index / Upload ​

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

用户管理(User) ​

方法路径权限码说明
GET/api/user/pagesys:user:page用户分页
GET/api/user/detail/:idsys:user:detail用户详情
POST/api/user/addsys:user:add添加用户
PUT/api/user/updatesys:user:update修改用户
DELETE/api/user/delete/:idsys:user:delete删除用户
DELETE/api/user/batchDeletesys:user:batchDelete批量删除
PUT/api/user/resetPwdsys:user:resetPwd重置密码
GET/api/user/exportsys:user:export导出用户
POST/api/user/importsys:user:import导入用户

角色管理(Role) ​

方法路径权限码说明
GET/api/role/pagesys:role:page角色分页
GET/api/role/listsys:role:list角色列表
GET/api/role/detail/:idsys:role:detail角色详情
POST/api/role/addsys:role:add添加角色
PUT/api/role/updatesys:role:update修改角色
DELETE/api/role/delete/:idsys:role:delete删除角色
DELETE/api/role/batchDeletesys:role:batchDelete批量删除
GET/api/role/menu/list/:idsys:role:getPermission查询角色菜单权限
POST/api/role/menu/savesys:role:savePermission授权角色菜单

菜单管理(Menu) ​

方法路径权限码说明
GET/api/menu/listsys:menu:list菜单列表
GET/api/menu/detail/:idsys:menu:detail菜单详情
POST/api/menu/addsys:menu:add添加菜单
PUT/api/menu/updatesys:menu:update修改菜单
DELETE/api/menu/delete/:idsys:menu:delete删除菜单

部门管理(Dept) ​

方法路径权限码说明
GET/api/dept/listsys:dept:list部门列表
GET/api/dept/detail/:idsys:dept:detail部门详情
POST/api/dept/addsys:dept:add添加部门
PUT/api/dept/updatesys:dept:update修改部门
DELETE/api/dept/delete/:idsys:dept:delete删除部门

职级 / 岗位(Level / Position) ​

方法路径权限码说明
GET/api/level/pagesys:level:page职级分页
GET/api/level/listsys:level:list职级列表
GET/api/level/detail/:idsys:level:detail职级详情
POST/api/level/addsys:level:add添加职级
PUT/api/level/updatesys:level:update修改职级
DELETE/api/level/delete/:idsys:level:delete删除职级
DELETE/api/level/batchDeletesys:level:batchDelete批量删除
GET/api/level/exportsys:level:export导出职级
POST/api/level/importsys:level:import导入职级
GET/api/position/pagesys:position:page岗位分页
GET/api/position/listsys:position:list岗位列表
GET/api/position/detail/:idsys:position:detail岗位详情
POST/api/position/addsys:position:add添加岗位
PUT/api/position/updatesys:position:update修改岗位
DELETE/api/position/delete/:idsys:position:delete删除岗位
DELETE/api/position/batchDeletesys:position:batchDelete批量删除

字典管理(Dict / DictItem) ​

方法路径权限码说明
GET/api/dict/pagesys:dict:page字典分页
GET/api/dict/detail/:idsys:dict:detail字典详情
POST/api/dict/addsys:dict:add添加字典
PUT/api/dict/updatesys:dict:update修改字典
DELETE/api/dict/delete/:idsys:dict:delete删除字典
DELETE/api/dict/batchDeletesys:dict:batchDelete批量删除
GET/api/dict/refreshCachesys:dict:update刷新字典缓存
GET/api/dict/item/pagesys:dict:page字典项分页
GET/api/dict/item/detail/:idsys:dict:detail字典项详情
POST/api/dict/item/addsys:dict:add添加字典项
PUT/api/dict/item/updatesys:dict:update修改字典项
DELETE/api/dict/item/delete/:idsys:dict:delete删除字典项
DELETE/api/dict/item/batchDeletesys:dict:batchDelete批量删除字典项
GET/api/dict/item/getDictItemList/:code-按编码查询字典项(前端下拉数据源)

内容管理(Category / Article / Notice / Link) ​

方法路径权限码说明
GET/api/category/listsys:category:list分类列表
GET/api/category/pagesys:category:page分类分页
GET/api/category/detail/:idsys:category:detail分类详情
POST/api/category/addsys:category:add添加分类
PUT/api/category/updatesys:category:update修改分类
DELETE/api/category/delete/:idsys:category:delete删除分类
DELETE/api/category/batchDeletesys:category:batchDelete批量删除
GET/api/article/pagesys:article:page文章分页
GET/api/article/listsys:article:list文章列表
GET/api/article/detail/:idsys:article:detail文章详情
POST/api/article/addsys:article:add添加文章
PUT/api/article/updatesys:article:update修改文章
DELETE/api/article/delete/:idsys:article:delete删除文章
DELETE/api/article/batchDeletesys:article:batchDelete批量删除
GET/api/notice/pagesys:notice:page通知分页
GET/api/notice/listsys:notice:list通知列表
GET/api/notice/detail/:idsys:notice:detail通知详情
POST/api/notice/addsys:notice:add添加通知
PUT/api/notice/updatesys:notice:update修改通知
DELETE/api/notice/delete/:idsys:notice:delete删除通知
DELETE/api/notice/batchDeletesys:notice:batchDelete批量删除
GET/api/link/pagesys🔗page友链分页
GET/api/link/listsys🔗list友链列表
GET/api/link/detail/:idsys🔗detail友链详情
POST/api/link/addsys🔗add添加友链
PUT/api/link/updatesys🔗update修改友链
DELETE/api/link/delete/:idsys🔗delete删除友链
DELETE/api/link/batchDeletesys🔗batchDelete批量删除

行政区划(City) ​

方法路径权限码说明
GET/api/city/listsys:city:list城市列表
GET/api/city/detail/:idsys:city:detail城市详情
POST/api/city/addsys:city:add添加城市
PUT/api/city/updatesys:city:update修改城市
DELETE/api/city/delete/:idsys:city:delete删除城市
DELETE/api/city/batchDeletesys:city:batchDelete批量删除
GET/api/city/getCityList/:code-按编码取下级
GET/api/city/getParent/:id-取上级
GET/api/city/findByParentCode-按父编码查询

系统配置(Config / ConfigItem / Param) ​

方法路径权限码说明
GET/api/config/pagesys:config:page配置分页
GET/api/config/listsys:config:list配置列表
GET/api/config/detail/:idsys:config:detail配置详情
POST/api/config/addsys:config:add添加配置
PUT/api/config/updatesys:config:update修改配置
DELETE/api/config/delete/:idsys:config:delete删除配置
DELETE/api/config/batchDeletesys:config:batchDelete批量删除
GET/api/config/web/indexsys:config:webIndex查询网站配置
POST/api/config/web/savesys:config:update保存网站配置
GET/api/config/item/pagesys:config:page配置项分页
GET/api/config/item/listsys:config:list配置项列表
GET/api/config/item/detail/:idsys:config:detail配置项详情
POST/api/config/item/addsys:config:add添加配置项
PUT/api/config/item/updatesys:config:update修改配置项
DELETE/api/config/item/delete/:idsys:config:delete删除配置项
DELETE/api/config/item/batchDeletesys:config:batchDelete批量删除配置项
GET/api/param/pagesys:param:page参数分页
GET/api/param/listsys:param:list参数列表
GET/api/param/detail/:idsys:param:detail参数详情
POST/api/param/addsys:param:add添加参数
PUT/api/param/updatesys:param:update修改参数
DELETE/api/param/delete/:idsys:param:delete删除参数
DELETE/api/param/batchDeletesys:param:batchDelete批量删除

租户管理(Tenant) ​

方法路径权限码说明
GET/api/tenant/pagesys:tenant:page租户分页
GET/api/tenant/listsys:tenant:list租户列表
GET/api/tenant/detail/:idsys:tenant:detail租户详情
POST/api/tenant/addsys:tenant:add添加租户
PUT/api/tenant/updatesys:tenant:update修改租户
DELETE/api/tenant/delete/:idsys:tenant:delete删除租户
DELETE/api/tenant/batchDeletesys:tenant:batchDelete批量删除
GET/api/tenant/users/:tenantIdsys:tenant:users租户用户
POST/api/tenant/accountsys:tenant:createAccount创建管理员账号

定时任务(Job / JobLog) ​

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

案例演示(Example) ​

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

文件模板(FileTemplate) ​

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

代码生成(Generator) ​

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

日志查询(LoginLog / OperLog) ​

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

说明

',39)])])}const E=d(i,[["render",r]]);export{y as __pageData,E as default};