2 lines
28 KiB
JavaScript
2 lines
28 KiB
JavaScript
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('<h1 id="E-API-接口速查表" tabindex="-1">E. API 接口速查表 <a class="header-anchor" href="#E-API-接口速查表" aria-label="Permalink to "E. API 接口速查表""></a></h1><div class="tip custom-block"><p class="custom-block-title">概述</p><p>本表列出所有 API 路由的完整清单(自动生成自 <code>routes/api.php</code> 与各控制器 <code>#[Permission]</code> 注解),包含 HTTP 方法、路径和所需权限码。批量删除统一为 <strong>DELETE</strong>(请求体仍传 ids 数组),其余遵循 REST 习惯。</p></div><h2 id="公开接口-免认证-" tabindex="-1">公开接口(免认证) <a class="header-anchor" href="#公开接口-免认证-" aria-label="Permalink to "公开接口(免认证)""></a></h2><p>定义在 <code>routes/api.php</code> 中间件组外,无需携带 Token:</p><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>说明</th></tr></thead><tbody><tr><td>POST</td><td><code>/api/login</code></td><td>用户登录</td></tr><tr><td>POST</td><td><code>/api/refresh</code></td><td>刷新 Token</td></tr><tr><td>GET</td><td><code>/api/captcha</code></td><td>获取验证码</td></tr><tr><td>POST</td><td><code>/api/oauth2/token</code></td><td>OAuth2 获取令牌</td></tr><tr><td>GET</td><td><code>/api/oauth2/check/token</code></td><td>检查令牌有效性</td></tr></tbody></table><h2 id="认证接口-auth-jwt-tenant-demo-log-operation-" tabindex="-1">认证接口(auth.jwt + tenant + demo + log.operation) <a class="header-anchor" href="#认证接口-auth-jwt-tenant-demo-log-operation-" aria-label="Permalink to "认证接口(auth.jwt + tenant + demo + log.operation)""></a></h2><h3 id="Auth-Index-Upload" tabindex="-1">Auth / Index / Upload <a class="header-anchor" href="#Auth-Index-Upload" aria-label="Permalink to "Auth / Index / Upload""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>POST</td><td><code>/api/logout</code></td><td>-</td><td>登出</td></tr><tr><td>DELETE</td><td><code>/api/oauth2/remove/:token</code></td><td>sys:auth:removeToken</td><td>吊销令牌</td></tr><tr><td>GET</td><td><code>/api/index/getUser</code></td><td>-</td><td>获取当前用户信息</td></tr><tr><td>GET</td><td><code>/api/index/getMenus</code></td><td>-</td><td>获取菜单列表</td></tr><tr><td>PUT</td><td><code>/api/index/updatePassword</code></td><td>-</td><td>修改密码</td></tr><tr><td>PUT</td><td><code>/api/index/updateProfile</code></td><td>-</td><td>修改个人资料</td></tr><tr><td>POST</td><td><code>/api/upload/uploadFile</code></td><td>sys:upload:file</td><td>上传文件</td></tr></tbody></table><h3 id="用户管理-User-" tabindex="-1">用户管理(User) <a class="header-anchor" href="#用户管理-User-" aria-label="Permalink to "用户管理(User)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/user/page</code></td><td>sys:user:page</td><td>用户分页</td></tr><tr><td>GET</td><td><code>/api/user/detail/:id</code></td><td>sys:user:detail</td><td>用户详情</td></tr><tr><td>POST</td><td><code>/api/user/add</code></td><td>sys:user:add</td><td>添加用户</td></tr><tr><td>PUT</td><td><code>/api/user/update</code></td><td>sys:user:update</td><td>修改用户</td></tr><tr><td>DELETE</td><td><code>/api/user/delete/:id</code></td><td>sys:user:delete</td><td>删除用户</td></tr><tr><td>DELETE</td><td><code>/api/user/batchDelete</code></td><td>sys:user:batchDelete</td><td>批量删除</td></tr><tr><td>PUT</td><td><code>/api/user/resetPwd</code></td><td>sys:user:resetPwd</td><td>重置密码</td></tr><tr><td>GET</td><td><code>/api/user/export</code></td><td>sys:user:export</td><td>导出用户</td></tr><tr><td>POST</td><td><code>/api/user/import</code></td><td>sys:user:import</td><td>导入用户</td></tr></tbody></table><h3 id="角色管理-Role-" tabindex="-1">角色管理(Role) <a class="header-anchor" href="#角色管理-Role-" aria-label="Permalink to "角色管理(Role)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/role/page</code></td><td>sys:role:page</td><td>角色分页</td></tr><tr><td>GET</td><td><code>/api/role/list</code></td><td>sys:role:list</td><td>角色列表</td></tr><tr><td>GET</td><td><code>/api/role/detail/:id</code></td><td>sys:role:detail</td><td>角色详情</td></tr><tr><td>POST</td><td><code>/api/role/add</code></td><td>sys:role:add</td><td>添加角色</td></tr><tr><td>PUT</td><td><code>/api/role/update</code></td><td>sys:role:update</td><td>修改角色</td></tr><tr><td>DELETE</td><td><code>/api/role/delete/:id</code></td><td>sys:role:delete</td><td>删除角色</td></tr><tr><td>DELETE</td><td><code>/api/role/batchDelete</code></td><td>sys:role:batchDelete</td><td>批量删除</td></tr><tr><td>GET</td><td><code>/api/role/menu/list/:id</code></td><td>sys:role:getPermission</td><td>查询角色菜单权限</td></tr><tr><td>POST</td><td><code>/api/role/menu/save</code></td><td>sys:role:savePermission</td><td>授权角色菜单</td></tr></tbody></table><h3 id="菜单管理-Menu-" tabindex="-1">菜单管理(Menu) <a class="header-anchor" href="#菜单管理-Menu-" aria-label="Permalink to "菜单管理(Menu)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/menu/list</code></td><td>sys:menu:list</td><td>菜单列表</td></tr><tr><td>GET</td><td><code>/api/menu/detail/:id</code></td><td>sys:menu:detail</td><td>菜单详情</td></tr><tr><td>POST</td><td><code>/api/menu/add</code></td><td>sys:menu:add</td><td>添加菜单</td></tr><tr><td>PUT</td><td><code>/api/menu/update</code></td><td>sys:menu:update</td><td>修改菜单</td></tr><tr><td>DELETE</td><td><code>/api/menu/delete/:id</code></td><td>sys:menu:delete</td><td>删除菜单</td></tr></tbody></table><h3 id="部门管理-Dept-" tabindex="-1">部门管理(Dept) <a class="header-anchor" href="#部门管理-Dept-" aria-label="Permalink to "部门管理(Dept)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/dept/list</code></td><td>sys:dept:list</td><td>部门列表</td></tr><tr><td>GET</td><td><code>/api/dept/detail/:id</code></td><td>sys:dept:detail</td><td>部门详情</td></tr><tr><td>POST</td><td><code>/api/dept/add</code></td><td>sys:dept:add</td><td>添加部门</td></tr><tr><td>PUT</td><td><code>/api/dept/update</code></td><td>sys:dept:update</td><td>修改部门</td></tr><tr><td>DELETE</td><td><code>/api/dept/delete/:id</code></td><td>sys:dept:delete</td><td>删除部门</td></tr></tbody></table><h3 id="职级-岗位-Level-Position-" tabindex="-1">职级 / 岗位(Level / Position) <a class="header-anchor" href="#职级-岗位-Level-Position-" aria-label="Permalink to "职级 / 岗位(Level / Position)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/level/page</code></td><td>sys:level:page</td><td>职级分页</td></tr><tr><td>GET</td><td><code>/api/level/list</code></td><td>sys:level:list</td><td>职级列表</td></tr><tr><td>GET</td><td><code>/api/level/detail/:id</code></td><td>sys:level:detail</td><td>职级详情</td></tr><tr><td>POST</td><td><code>/api/level/add</code></td><td>sys:level:add</td><td>添加职级</td></tr><tr><td>PUT</td><td><code>/api/level/update</code></td><td>sys:level:update</td><td>修改职级</td></tr><tr><td>DELETE</td><td><code>/api/level/delete/:id</code></td><td>sys:level:delete</td><td>删除职级</td></tr><tr><td>DELETE</td><td><code>/api/level/batchDelete</code></td><td>sys:level:batchDelete</td><td>批量删除</td></tr><tr><td>GET</td><td><code>/api/level/export</code></td><td>sys:level:export</td><td>导出职级</td></tr><tr><td>POST</td><td><code>/api/level/import</code></td><td>sys:level:import</td><td>导入职级</td></tr><tr><td>GET</td><td><code>/api/position/page</code></td><td>sys:position:page</td><td>岗位分页</td></tr><tr><td>GET</td><td><code>/api/position/list</code></td><td>sys:position:list</td><td>岗位列表</td></tr><tr><td>GET</td><td><code>/api/position/detail/:id</code></td><td>sys:position:detail</td><td>岗位详情</td></tr><tr><td>POST</td><td><code>/api/position/add</code></td><td>sys:position:add</td><td>添加岗位</td></tr><tr><td>PUT</td><td><code>/api/position/update</code></td><td>sys:position:update</td><td>修改岗位</td></tr><tr><td>DELETE</td><td><code>/api/position/delete/:id</code></td><td>sys:position:delete</td><td>删除岗位</td></tr><tr><td>DELETE</td><td><code>/api/position/batchDelete</code></td><td>sys:position:batchDelete</td><td>批量删除</td></tr></tbody></table><h3 id="字典管理-Dict-DictItem-" tabindex="-1">字典管理(Dict / DictItem) <a class="header-anchor" href="#字典管理-Dict-DictItem-" aria-label="Permalink to "字典管理(Dict / DictItem)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/dict/page</code></td><td>sys:dict:page</td><td>字典分页</td></tr><tr><td>GET</td><td><code>/api/dict/detail/:id</code></td><td>sys:dict:detail</td><td>字典详情</td></tr><tr><td>POST</td><td><code>/api/dict/add</code></td><td>sys:dict:add</td><td>添加字典</td></tr><tr><td>PUT</td><td><code>/api/dict/update</code></td><td>sys:dict:update</td><td>修改字典</td></tr><tr><td>DELETE</td><td><code>/api/dict/delete/:id</code></td><td>sys:dict:delete</td><td>删除字典</td></tr><tr><td>DELETE</td><td><code>/api/dict/batchDelete</code></td><td>sys:dict:batchDelete</td><td>批量删除</td></tr><tr><td>GET</td><td><code>/api/dict/refreshCache</code></td><td>sys:dict:update</td><td>刷新字典缓存</td></tr><tr><td>GET</td><td><code>/api/dict/item/page</code></td><td>sys:dict:page</td><td>字典项分页</td></tr><tr><td>GET</td><td><code>/api/dict/item/detail/:id</code></td><td>sys:dict:detail</td><td>字典项详情</td></tr><tr><td>POST</td><td><code>/api/dict/item/add</code></td><td>sys:dict:add</td><td>添加字典项</td></tr><tr><td>PUT</td><td><code>/api/dict/item/update</code></td><td>sys:dict:update</td><td>修改字典项</td></tr><tr><td>DELETE</td><td><code>/api/dict/item/delete/:id</code></td><td>sys:dict:delete</td><td>删除字典项</td></tr><tr><td>DELETE</td><td><code>/api/dict/item/batchDelete</code></td><td>sys:dict:batchDelete</td><td>批量删除字典项</td></tr><tr><td>GET</td><td><code>/api/dict/item/getDictItemList/:code</code></td><td>-</td><td>按编码查询字典项(前端下拉数据源)</td></tr></tbody></table><h3 id="内容管理-Category-Article-Notice-Link-" tabindex="-1">内容管理(Category / Article / Notice / Link) <a class="header-anchor" href="#内容管理-Category-Article-Notice-Link-" aria-label="Permalink to "内容管理(Category / Article / Notice / Link)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/category/list</code></td><td>sys:category:list</td><td>分类列表</td></tr><tr><td>GET</td><td><code>/api/category/page</code></td><td>sys:category:page</td><td>分类分页</td></tr><tr><td>GET</td><td><code>/api/category/detail/:id</code></td><td>sys:category:detail</td><td>分类详情</td></tr><tr><td>POST</td><td><code>/api/category/add</code></td><td>sys:category:add</td><td>添加分类</td></tr><tr><td>PUT</td><td><code>/api/category/update</code></td><td>sys:category:update</td><td>修改分类</td></tr><tr><td>DELETE</td><td><code>/api/category/delete/:id</code></td><td>sys:category:delete</td><td>删除分类</td></tr><tr><td>DELETE</td><td><code>/api/category/batchDelete</code></td><td>sys:category:batchDelete</td><td>批量删除</td></tr><tr><td>GET</td><td><code>/api/article/page</code></td><td>sys:article:page</td><td>文章分页</td></tr><tr><td>GET</td><td><code>/api/article/list</code></td><td>sys:article:list</td><td>文章列表</td></tr><tr><td>GET</td><td><code>/api/article/detail/:id</code></td><td>sys:article:detail</td><td>文章详情</td></tr><tr><td>POST</td><td><code>/api/article/add</code></td><td>sys:article:add</td><td>添加文章</td></tr><tr><td>PUT</td><td><code>/api/article/update</code></td><td>sys:article:update</td><td>修改文章</td></tr><tr><td>DELETE</td><td><code>/api/article/delete/:id</code></td><td>sys:article:delete</td><td>删除文章</td></tr><tr><td>DELETE</td><td><code>/api/article/batchDelete</code></td><td>sys:article:batchDelete</td><td>批量删除</td></tr><tr><td>GET</td><td><code>/api/notice/page</code></td><td>sys:notice:page</td><td>通知分页</td></tr><tr><td>GET</td><td><code>/api/notice/list</code></td><td>sys:notice:list</td><td>通知列表</td></tr><tr><td>GET</td><td><code>/api/notice/detail/:id</code></td><td>sys:notice:detail</td><td>通知详情</td></tr><tr><td>POST</td><td><code>/api/notice/add</code></td><td>sys:notice:add</td><td>添加通知</td></tr><tr><td>PUT</td><td><code>/api/notice/update</code></td><td>sys:notice:update</td><td>修改通知</td></tr><tr><td>DELETE</td><td><code>/api/notice/delete/:id</code></td><td>sys:notice:delete</td><td>删除通知</td></tr><tr><td>DELETE</td><td><code>/api/notice/batchDelete</code></td><td>sys:notice:batchDelete</td><td>批量删除</td></tr><tr><td>GET</td><td><code>/api/link/page</code></td><td>sys🔗page</td><td>友链分页</td></tr><tr><td>GET</td><td><code>/api/link/list</code></td><td>sys🔗list</td><td>友链列表</td></tr><tr><td>GET</td><td><code>/api/link/detail/:id</code></td><td>sys🔗detail</td><td>友链详情</td></tr><tr><td>POST</td><td><code>/api/link/add</code></td><td>sys🔗add</td><td>添加友链</td></tr><tr><td>PUT</td><td><code>/api/link/update</code></td><td>sys🔗update</td><td>修改友链</td></tr><tr><td>DELETE</td><td><code>/api/link/delete/:id</code></td><td>sys🔗delete</td><td>删除友链</td></tr><tr><td>DELETE</td><td><code>/api/link/batchDelete</code></td><td>sys🔗batchDelete</td><td>批量删除</td></tr></tbody></table><h3 id="行政区划-City-" tabindex="-1">行政区划(City) <a class="header-anchor" href="#行政区划-City-" aria-label="Permalink to "行政区划(City)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/city/list</code></td><td>sys:city:list</td><td>城市列表</td></tr><tr><td>GET</td><td><code>/api/city/detail/:id</code></td><td>sys:city:detail</td><td>城市详情</td></tr><tr><td>POST</td><td><code>/api/city/add</code></td><td>sys:city:add</td><td>添加城市</td></tr><tr><td>PUT</td><td><code>/api/city/update</code></td><td>sys:city:update</td><td>修改城市</td></tr><tr><td>DELETE</td><td><code>/api/city/delete/:id</code></td><td>sys:city:delete</td><td>删除城市</td></tr><tr><td>DELETE</td><td><code>/api/city/batchDelete</code></td><td>sys:city:batchDelete</td><td>批量删除</td></tr><tr><td>GET</td><td><code>/api/city/getCityList/:code</code></td><td>-</td><td>按编码取下级</td></tr><tr><td>GET</td><td><code>/api/city/getParent/:id</code></td><td>-</td><td>取上级</td></tr><tr><td>GET</td><td><code>/api/city/findByParentCode</code></td><td>-</td><td>按父编码查询</td></tr></tbody></table><h3 id="系统配置-Config-ConfigItem-Param-" tabindex="-1">系统配置(Config / ConfigItem / Param) <a class="header-anchor" href="#系统配置-Config-ConfigItem-Param-" aria-label="Permalink to "系统配置(Config / ConfigItem / Param)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/config/page</code></td><td>sys:config:page</td><td>配置分页</td></tr><tr><td>GET</td><td><code>/api/config/list</code></td><td>sys:config:list</td><td>配置列表</td></tr><tr><td>GET</td><td><code>/api/config/detail/:id</code></td><td>sys:config:detail</td><td>配置详情</td></tr><tr><td>POST</td><td><code>/api/config/add</code></td><td>sys:config:add</td><td>添加配置</td></tr><tr><td>PUT</td><td><code>/api/config/update</code></td><td>sys:config:update</td><td>修改配置</td></tr><tr><td>DELETE</td><td><code>/api/config/delete/:id</code></td><td>sys:config:delete</td><td>删除配置</td></tr><tr><td>DELETE</td><td><code>/api/config/batchDelete</code></td><td>sys:config:batchDelete</td><td>批量删除</td></tr><tr><td>GET</td><td><code>/api/config/web/index</code></td><td>sys:config:webIndex</td><td>查询网站配置</td></tr><tr><td>POST</td><td><code>/api/config/web/save</code></td><td>sys:config:update</td><td>保存网站配置</td></tr><tr><td>GET</td><td><code>/api/config/item/page</code></td><td>sys:config:page</td><td>配置项分页</td></tr><tr><td>GET</td><td><code>/api/config/item/list</code></td><td>sys:config:list</td><td>配置项列表</td></tr><tr><td>GET</td><td><code>/api/config/item/detail/:id</code></td><td>sys:config:detail</td><td>配置项详情</td></tr><tr><td>POST</td><td><code>/api/config/item/add</code></td><td>sys:config:add</td><td>添加配置项</td></tr><tr><td>PUT</td><td><code>/api/config/item/update</code></td><td>sys:config:update</td><td>修改配置项</td></tr><tr><td>DELETE</td><td><code>/api/config/item/delete/:id</code></td><td>sys:config:delete</td><td>删除配置项</td></tr><tr><td>DELETE</td><td><code>/api/config/item/batchDelete</code></td><td>sys:config:batchDelete</td><td>批量删除配置项</td></tr><tr><td>GET</td><td><code>/api/param/page</code></td><td>sys:param:page</td><td>参数分页</td></tr><tr><td>GET</td><td><code>/api/param/list</code></td><td>sys:param:list</td><td>参数列表</td></tr><tr><td>GET</td><td><code>/api/param/detail/:id</code></td><td>sys:param:detail</td><td>参数详情</td></tr><tr><td>POST</td><td><code>/api/param/add</code></td><td>sys:param:add</td><td>添加参数</td></tr><tr><td>PUT</td><td><code>/api/param/update</code></td><td>sys:param:update</td><td>修改参数</td></tr><tr><td>DELETE</td><td><code>/api/param/delete/:id</code></td><td>sys:param:delete</td><td>删除参数</td></tr><tr><td>DELETE</td><td><code>/api/param/batchDelete</code></td><td>sys:param:batchDelete</td><td>批量删除</td></tr></tbody></table><h3 id="租户管理-Tenant-" tabindex="-1">租户管理(Tenant) <a class="header-anchor" href="#租户管理-Tenant-" aria-label="Permalink to "租户管理(Tenant)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/tenant/page</code></td><td>sys:tenant:page</td><td>租户分页</td></tr><tr><td>GET</td><td><code>/api/tenant/list</code></td><td>sys:tenant:list</td><td>租户列表</td></tr><tr><td>GET</td><td><code>/api/tenant/detail/:id</code></td><td>sys:tenant:detail</td><td>租户详情</td></tr><tr><td>POST</td><td><code>/api/tenant/add</code></td><td>sys:tenant:add</td><td>添加租户</td></tr><tr><td>PUT</td><td><code>/api/tenant/update</code></td><td>sys:tenant:update</td><td>修改租户</td></tr><tr><td>DELETE</td><td><code>/api/tenant/delete/:id</code></td><td>sys:tenant:delete</td><td>删除租户</td></tr><tr><td>DELETE</td><td><code>/api/tenant/batchDelete</code></td><td>sys:tenant:batchDelete</td><td>批量删除</td></tr><tr><td>GET</td><td><code>/api/tenant/users/:tenantId</code></td><td>sys:tenant:users</td><td>租户用户</td></tr><tr><td>POST</td><td><code>/api/tenant/account</code></td><td>sys:tenant:createAccount</td><td>创建管理员账号</td></tr></tbody></table><h3 id="定时任务-Job-JobLog-" tabindex="-1">定时任务(Job / JobLog) <a class="header-anchor" href="#定时任务-Job-JobLog-" aria-label="Permalink to "定时任务(Job / JobLog)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/job/page</code></td><td>sys:job:page</td><td>任务分页</td></tr><tr><td>GET</td><td><code>/api/job/list</code></td><td>sys:job:list</td><td>任务列表</td></tr><tr><td>GET</td><td><code>/api/job/detail/:id</code></td><td>sys:job:detail</td><td>任务详情</td></tr><tr><td>POST</td><td><code>/api/job/add</code></td><td>sys:job:add</td><td>添加任务</td></tr><tr><td>PUT</td><td><code>/api/job/update</code></td><td>sys:job:update</td><td>修改任务</td></tr><tr><td>DELETE</td><td><code>/api/job/delete/:id</code></td><td>sys:job:delete</td><td>删除任务</td></tr><tr><td>DELETE</td><td><code>/api/job/batchDelete</code></td><td>sys:job:batchDelete</td><td>批量删除</td></tr><tr><td>GET</td><td><code>/api/job/runOnce/:id</code></td><td>sys:job:execute</td><td>立即执行任务</td></tr><tr><td>POST</td><td><code>/api/job/status</code></td><td>sys:job:update</td><td>修改任务状态</td></tr><tr><td>GET</td><td><code>/api/job/pause/:id</code></td><td>sys:job:pause</td><td>暂停任务</td></tr><tr><td>GET</td><td><code>/api/job/resume/:id</code></td><td>sys:job:resume</td><td>恢复任务</td></tr><tr><td>GET</td><td><code>/api/job/daemonStatus</code></td><td>-</td><td>守护进程状态</td></tr><tr><td>GET</td><td><code>/api/job/log/page</code></td><td>sys:job:page</td><td>任务日志分页</td></tr><tr><td>GET</td><td><code>/api/job/log/detail/:id</code></td><td>sys:job:detail</td><td>任务日志详情</td></tr><tr><td>DELETE</td><td><code>/api/job/log/delete/:id</code></td><td>sys:job:delete</td><td>删除任务日志</td></tr><tr><td>DELETE</td><td><code>/api/job/log/batchDelete</code></td><td>sys:job:batchDelete</td><td>批量删除</td></tr></tbody></table><h3 id="案例演示-Example-" tabindex="-1">案例演示(Example) <a class="header-anchor" href="#案例演示-Example-" aria-label="Permalink to "案例演示(Example)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/example/page</code></td><td>sys:example:page</td><td>示例分页</td></tr><tr><td>GET</td><td><code>/api/example/list</code></td><td>sys:example:list</td><td>示例列表</td></tr><tr><td>GET</td><td><code>/api/example/detail/:id</code></td><td>sys:example:detail</td><td>示例详情</td></tr><tr><td>POST</td><td><code>/api/example/add</code></td><td>sys:example:add</td><td>添加示例</td></tr><tr><td>PUT</td><td><code>/api/example/update</code></td><td>sys:example:update</td><td>修改示例</td></tr><tr><td>DELETE</td><td><code>/api/example/delete/:id</code></td><td>sys:example:delete</td><td>删除示例</td></tr><tr><td>DELETE</td><td><code>/api/example/batchDelete</code></td><td>sys:example:batchDelete</td><td>批量删除</td></tr><tr><td>GET</td><td><code>/api/example/export</code></td><td>sys:example:export</td><td>导出示例</td></tr><tr><td>POST</td><td><code>/api/example/import</code></td><td>sys:example:import</td><td>导入示例</td></tr></tbody></table><h3 id="文件模板-FileTemplate-" tabindex="-1">文件模板(FileTemplate) <a class="header-anchor" href="#文件模板-FileTemplate-" aria-label="Permalink to "文件模板(FileTemplate)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/file/template/page</code></td><td>sys:fileTemplate:page</td><td>模板分页</td></tr><tr><td>GET</td><td><code>/api/file/template/detail/:id</code></td><td>sys:fileTemplate:detail</td><td>模板详情</td></tr><tr><td>POST</td><td><code>/api/file/template/add</code></td><td>sys:fileTemplate:add</td><td>添加模板</td></tr><tr><td>PUT</td><td><code>/api/file/template/update</code></td><td>sys:fileTemplate:update</td><td>修改模板</td></tr><tr><td>DELETE</td><td><code>/api/file/template/delete/:id</code></td><td>sys:fileTemplate:delete</td><td>删除模板</td></tr><tr><td>DELETE</td><td><code>/api/file/template/batchDelete</code></td><td>sys:fileTemplate:batchDelete</td><td>批量删除</td></tr><tr><td>GET</td><td><code>/api/file/template/getTemplateByCode/:code</code></td><td>-</td><td>按编码取模板(导入模板下载)</td></tr></tbody></table><h3 id="代码生成-Generator-" tabindex="-1">代码生成(Generator) <a class="header-anchor" href="#代码生成-Generator-" aria-label="Permalink to "代码生成(Generator)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/generator/page</code></td><td>sys:generator:page</td><td>数据表分页</td></tr><tr><td>GET</td><td><code>/api/generator/preview</code></td><td>sys:generator:generate</td><td>预览生成代码</td></tr><tr><td>POST</td><td><code>/api/generator/generate</code></td><td>sys:generator:generate</td><td>一键生成</td></tr><tr><td>POST</td><td><code>/api/generator/batchGenerate</code></td><td>sys:generator:generate</td><td>批量生成</td></tr></tbody></table><h3 id="日志查询-LoginLog-OperLog-" tabindex="-1">日志查询(LoginLog / OperLog) <a class="header-anchor" href="#日志查询-LoginLog-OperLog-" aria-label="Permalink to "日志查询(LoginLog / OperLog)""></a></h3><table tabindex="0"><thead><tr><th>方法</th><th>路径</th><th>权限码</th><th>说明</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/login/log/page</code></td><td>sys:loginLog:page</td><td>登录日志分页</td></tr><tr><td>GET</td><td><code>/api/login/log/detail/:id</code></td><td>sys:loginLog:detail</td><td>登录日志详情</td></tr><tr><td>DELETE</td><td><code>/api/login/log/delete/:id</code></td><td>sys:loginLog:delete</td><td>删除登录日志</td></tr><tr><td>DELETE</td><td><code>/api/login/log/batchDelete</code></td><td>sys:loginLog:batchDelete</td><td>批量删除</td></tr><tr><td>GET</td><td><code>/api/oper/log/page</code></td><td>sys:operLog:page</td><td>操作日志分页</td></tr><tr><td>GET</td><td><code>/api/oper/log/detail/:id</code></td><td>sys:operLog:detail</td><td>操作日志详情</td></tr><tr><td>DELETE</td><td><code>/api/oper/log/delete/:id</code></td><td>sys:operLog:delete</td><td>删除操作日志</td></tr><tr><td>DELETE</td><td><code>/api/oper/log/batchDelete</code></td><td>sys:operLog:batchDelete</td><td>批量删除</td></tr></tbody></table><div class="info custom-block"><p class="custom-block-title">说明</p><ul><li>权限码取自控制器方法的 <code>#[Permission]</code> 注解;<code>-</code> 表示该接口仅需登录(无独立权限码)</li><li>任务日志(jobLog)复用 <code>sys:job:*</code> 权限码</li><li>字典项 / 模板 / 行政区划的 <code>getDictItemList</code>、<code>getTemplateByCode</code>、<code>getCityList</code> 等读取接口免独立权限,登录即可访问</li><li>路径中 <code>:id</code> 为路径参数;查询参数、请求体规范见 <a href="/zh/api-spec/response.html">8. 接口规范与对接</a></li></ul></div>',39)])])}const E=d(i,[["render",r]]);export{y as __pageData,E as default};
|