7 lines
25 KiB
JavaScript
7 lines
25 KiB
JavaScript
import{_ as d,o as e,c as a,a2 as o}from"./chunks/framework.BbmSSMjL.js";const E=JSON.parse('{"title":"8.7 API 接口总览","description":"","frontmatter":{},"headers":[],"relativePath":"zh/api-spec/overview.md","filePath":"zh/api-spec/overview.md"}'),i={name:"zh/api-spec/overview.md"};function c(r,t,p,s,l,h){return e(),a("div",null,[...t[0]||(t[0]=[o(`<h1 id="_8-7-API-接口总览" tabindex="-1">8.7 API 接口总览 <a class="header-anchor" href="#_8-7-API-接口总览" aria-label="Permalink to "8.7 API 接口总览""></a></h1><div class="tip custom-block"><p class="custom-block-title">概述</p><p>本节按模块分组列出所有 API 接口的概述（全部来自 <code>routes/api.php</code> 实际路由），详细路由清单见 <a href="/zh/appendix/api-cheatsheet.html">附录 E API 接口速查表</a>。</p></div><h2 id="API-设计规范" tabindex="-1">API 设计规范 <a class="header-anchor" href="#API-设计规范" aria-label="Permalink to "API 设计规范""></a></h2><h3 id="命名规范" tabindex="-1">命名规范 <a class="header-anchor" href="#命名规范" aria-label="Permalink to "命名规范""></a></h3><table tabindex="0"><thead><tr><th>规范</th><th>说明</th><th>示例</th></tr></thead><tbody><tr><td>URL 风格</td><td>小驼峰/小写下划线混合，前缀 <code>/api</code>（<code>bootstrap/app.php</code> 统一添加）</td><td><code>/api/user/page</code></td></tr><tr><td>模块名</td><td>与 Controller 对应</td><td><code>user</code>、<code>article</code>、<code>dict</code></td></tr><tr><td>操作名</td><td>标准 CRUD 动词</td><td><code>page</code>、<code>list</code>、<code>detail</code>、<code>add</code>、<code>update</code>、<code>delete</code>、<code>batchDelete</code></td></tr><tr><td>扩展操作</td><td>业务动词</td><td><code>import</code>、<code>export</code>、<code>resetPwd</code>、<code>refreshCache</code>、<code>runOnce</code></td></tr></tbody></table><h3 id="HTTP-方法规范" tabindex="-1">HTTP 方法规范 <a class="header-anchor" href="#HTTP-方法规范" aria-label="Permalink to "HTTP 方法规范""></a></h3><table tabindex="0"><thead><tr><th>操作</th><th>HTTP 方法</th><th>URL 示例</th><th>说明</th></tr></thead><tbody><tr><td>分页查询</td><td>GET</td><td><code>/api/user/page</code></td><td>参数在 URL query string</td></tr><tr><td>全量列表</td><td>GET</td><td><code>/api/role/list</code></td><td>参数在 URL query string（<code>list</code> 路由按模块提供，如 role/dept/menu；user 模块仅分页）</td></tr><tr><td>详情</td><td>GET</td><td><code>/api/user/detail/{id}</code></td><td>ID 在 URL 路径</td></tr><tr><td>新增</td><td>POST</td><td><code>/api/user/add</code></td><td>参数在 JSON 请求体</td></tr><tr><td>修改</td><td>PUT</td><td><code>/api/user/update</code></td><td>参数在 JSON 请求体（含 id）</td></tr><tr><td>删除</td><td>DELETE</td><td><code>/api/user/delete/{id}</code></td><td>ID 在 URL 路径</td></tr><tr><td>批量删除</td><td><strong>DELETE</strong></td><td><code>/api/user/batchDelete</code></td><td>ids 在 JSON 请求体（<strong>本项目统一 DELETE + body</strong>）</td></tr></tbody></table><h3 id="统一响应格式" tabindex="-1">统一响应格式 <a class="header-anchor" href="#统一响应格式" aria-label="Permalink to "统一响应格式""></a></h3><div class="language-json vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki shiki-themes dracula-soft vitesse-light vp-code" tabindex="0"><code><span class="line"><span style="--shiki-dark:#F6F6F4;--shiki-light:#999999;">{</span></span>
|
||
<span class="line"><span style="--shiki-dark:#97E2F2;--shiki-light:#99841877;"> "</span><span style="--shiki-dark:#97E1F1;--shiki-light:#998418;">code</span><span style="--shiki-dark:#97E2F2;--shiki-light:#99841877;">"</span><span style="--shiki-dark:#F286C4;--shiki-light:#999999;">:</span><span style="--shiki-dark:#BF9EEE;--shiki-light:#2F798A;"> 0</span><span style="--shiki-dark:#F6F6F4;--shiki-light:#999999;">,</span><span style="--shiki-dark:#7B7F8B;--shiki-light:#A0ADA0;"> // 0=成功，其他=失败</span></span>
|
||
<span class="line"><span style="--shiki-dark:#97E2F2;--shiki-light:#99841877;"> "</span><span style="--shiki-dark:#97E1F1;--shiki-light:#998418;">ok</span><span style="--shiki-dark:#97E2F2;--shiki-light:#99841877;">"</span><span style="--shiki-dark:#F286C4;--shiki-light:#999999;">:</span><span style="--shiki-dark:#BF9EEE;--shiki-light:#1E754F;"> true</span><span style="--shiki-dark:#F6F6F4;--shiki-light:#999999;">,</span><span style="--shiki-dark:#7B7F8B;--shiki-light:#A0ADA0;"> // 是否成功</span></span>
|
||
<span class="line"><span style="--shiki-dark:#97E2F2;--shiki-light:#99841877;"> "</span><span style="--shiki-dark:#97E1F1;--shiki-light:#998418;">msg</span><span style="--shiki-dark:#97E2F2;--shiki-light:#99841877;">"</span><span style="--shiki-dark:#F286C4;--shiki-light:#999999;">:</span><span style="--shiki-dark:#DEE492;--shiki-light:#B5695977;"> "</span><span style="--shiki-dark:#E7EE98;--shiki-light:#B56959;">操作成功</span><span style="--shiki-dark:#DEE492;--shiki-light:#B5695977;">"</span><span style="--shiki-dark:#F6F6F4;--shiki-light:#999999;">,</span><span style="--shiki-dark:#7B7F8B;--shiki-light:#A0ADA0;"> // 提示信息</span></span>
|
||
<span class="line"><span style="--shiki-dark:#97E2F2;--shiki-light:#99841877;"> "</span><span style="--shiki-dark:#97E1F1;--shiki-light:#998418;">data</span><span style="--shiki-dark:#97E2F2;--shiki-light:#99841877;">"</span><span style="--shiki-dark:#F286C4;--shiki-light:#999999;">:</span><span style="--shiki-dark:#F6F6F4;--shiki-light:#999999;"> {}</span><span style="--shiki-dark:#7B7F8B;--shiki-light:#A0ADA0;"> // 响应数据</span></span>
|
||
<span class="line"><span style="--shiki-dark:#F6F6F4;--shiki-light:#999999;">}</span></span></code></pre></div><h3 id="认证方式" tabindex="-1">认证方式 <a class="header-anchor" href="#认证方式" aria-label="Permalink to "认证方式""></a></h3><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes dracula-soft vitesse-light vp-code" tabindex="0"><code><span class="line"><span>Authorization: Bearer <access_token></span></span></code></pre></div><p>公开接口放在 <code>routes/api.php</code> 中间件组<strong>外</strong>，认证接口统一在 <code>['auth.jwt', 'tenant', 'demo', 'log.operation']</code> 组内。</p><h2 id="公开接口-无需认证-" tabindex="-1">公开接口（无需认证） <a class="header-anchor" href="#公开接口-无需认证-" aria-label="Permalink to "公开接口（无需认证）""></a></h2><table tabindex="0"><thead><tr><th>模块</th><th>接口</th><th>方法</th><th>说明</th></tr></thead><tbody><tr><td>登录</td><td><code>/api/login</code></td><td>POST</td><td>用户登录，返回双令牌</td></tr><tr><td>刷新</td><td><code>/api/refresh</code></td><td>POST</td><td>refresh_token 换取新令牌对</td></tr><tr><td>验证码</td><td><code>/api/captcha</code></td><td>GET</td><td>获取图片验证码</td></tr><tr><td>Token</td><td><code>/api/oauth2/token</code></td><td>POST</td><td>OAuth2 兼容获取/刷新 Token</td></tr><tr><td>Token</td><td><code>/api/oauth2/check/token</code></td><td>GET</td><td>检查 Token 有效性</td></tr></tbody></table><h2 id="认证接口-组内-其余全部-" tabindex="-1">认证接口（组内，其余全部） <a class="header-anchor" href="#认证接口-组内-其余全部-" aria-label="Permalink to "认证接口（组内，其余全部）""></a></h2><p>以下模块接口均位于认证中间件组内，需要 <code>Authorization</code> 头。</p><h3 id="个人中心与公共" tabindex="-1">个人中心与公共 <a class="header-anchor" href="#个人中心与公共" aria-label="Permalink to "个人中心与公共""></a></h3><table tabindex="0"><thead><tr><th>模块</th><th>主要接口</th><th>方法</th><th>说明</th></tr></thead><tbody><tr><td>登出</td><td><code>/api/logout</code></td><td>POST</td><td>登出（吊销 refresh_token + 记录日志）</td></tr><tr><td>Token</td><td><code>/api/oauth2/remove/{token}</code></td><td>DELETE</td><td>吊销指定令牌</td></tr><tr><td>首页</td><td><code>/api/index/getUser</code></td><td>GET</td><td>获取当前用户信息（含角色与权限）</td></tr><tr><td>首页</td><td><code>/api/index/getMenus</code></td><td>GET</td><td>获取菜单树（动态路由数据源）</td></tr><tr><td>首页</td><td><code>/api/index/updatePassword</code></td><td>PUT</td><td>修改密码（改密后全端下线）</td></tr><tr><td>首页</td><td><code>/api/index/updateProfile</code></td><td>PUT</td><td>更新个人信息</td></tr><tr><td>上传</td><td><code>/api/upload/uploadFile</code></td><td>POST</td><td>上传文件（需 <code>sys:upload:file</code> 权限）</td></tr></tbody></table><h3 id="系统管理" tabindex="-1">系统管理 <a class="header-anchor" href="#系统管理" aria-label="Permalink to "系统管理""></a></h3><table tabindex="0"><thead><tr><th>模块</th><th>主要接口</th><th>方法</th><th>说明</th></tr></thead><tbody><tr><td>用户</td><td><code>/api/user/page</code> <code>detail/{id}</code></td><td>GET</td><td>分页 / 详情</td></tr><tr><td>用户</td><td><code>/api/user/add</code> <code>import</code></td><td>POST</td><td>新增 / Excel 导入</td></tr><tr><td>用户</td><td><code>/api/user/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>用户</td><td><code>/api/user/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>用户</td><td><code>/api/user/resetPwd</code></td><td>PUT</td><td>重置密码</td></tr><tr><td>用户</td><td><code>/api/user/delete/{id}</code> <code>export</code></td><td>DELETE / GET</td><td>删除 / Excel 导出</td></tr><tr><td>角色</td><td><code>/api/role/page</code> <code>list</code> <code>detail/{id}</code></td><td>GET</td><td>分页 / 全量 / 详情</td></tr><tr><td>角色</td><td><code>/api/role/add</code> <code>menu/save</code></td><td>POST</td><td>新增 / 保存菜单权限</td></tr><tr><td>角色</td><td><code>/api/role/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>角色</td><td><code>/api/role/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>角色</td><td><code>/api/role/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>角色</td><td><code>/api/role/menu/list/{id}</code></td><td>GET</td><td>获取角色菜单（含选中状态）</td></tr><tr><td>菜单</td><td><code>/api/menu/list</code> <code>detail/{id}</code></td><td>GET</td><td>树形列表 / 详情</td></tr><tr><td>菜单</td><td><code>/api/menu/add</code></td><td>POST</td><td>新增</td></tr><tr><td>菜单</td><td><code>/api/menu/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>菜单</td><td><code>/api/menu/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>部门</td><td><code>/api/dept/list</code> <code>detail/{id}</code></td><td>GET</td><td>树形列表 / 详情</td></tr><tr><td>部门</td><td><code>/api/dept/add</code></td><td>POST</td><td>新增</td></tr><tr><td>部门</td><td><code>/api/dept/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>部门</td><td><code>/api/dept/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>职级</td><td><code>/api/level/page</code> <code>list</code> <code>detail/{id}</code></td><td>GET</td><td>分页 / 全量 / 详情</td></tr><tr><td>职级</td><td><code>/api/level/add</code> <code>import</code></td><td>POST</td><td>新增 / Excel 导入</td></tr><tr><td>职级</td><td><code>/api/level/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>职级</td><td><code>/api/level/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>职级</td><td><code>/api/level/delete/{id}</code> <code>export</code></td><td>DELETE / GET</td><td>删除 / Excel 导出</td></tr><tr><td>岗位</td><td><code>/api/position/page</code> <code>list</code> <code>detail/{id}</code></td><td>GET</td><td>分页 / 全量 / 详情</td></tr><tr><td>岗位</td><td><code>/api/position/add</code></td><td>POST</td><td>新增</td></tr><tr><td>岗位</td><td><code>/api/position/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>岗位</td><td><code>/api/position/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>岗位</td><td><code>/api/position/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>租户</td><td><code>/api/tenant/page</code> <code>list</code> <code>detail/{id}</code></td><td>GET</td><td>分页 / 全量 / 详情</td></tr><tr><td>租户</td><td><code>/api/tenant/add</code> <code>account</code></td><td>POST</td><td>新增 / 创建租户账号</td></tr><tr><td>租户</td><td><code>/api/tenant/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>租户</td><td><code>/api/tenant/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>租户</td><td><code>/api/tenant/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>租户</td><td><code>/api/tenant/users/{tenantId}</code></td><td>GET</td><td>租户用户列表</td></tr></tbody></table><h3 id="数据管理" tabindex="-1">数据管理 <a class="header-anchor" href="#数据管理" aria-label="Permalink to "数据管理""></a></h3><table tabindex="0"><thead><tr><th>模块</th><th>主要接口</th><th>方法</th><th>说明</th></tr></thead><tbody><tr><td>字典</td><td><code>/api/dict/page</code> <code>detail/{id}</code></td><td>GET</td><td>分页 / 详情</td></tr><tr><td>字典</td><td><code>/api/dict/add</code></td><td>POST</td><td>新增</td></tr><tr><td>字典</td><td><code>/api/dict/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>字典</td><td><code>/api/dict/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>字典</td><td><code>/api/dict/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>字典</td><td><code>/api/dict/refreshCache</code></td><td>GET</td><td>刷新字典缓存（<code>#[DemoAllow]</code>）</td></tr><tr><td>字典项</td><td><code>/api/dict/item/page</code> <code>detail/{id}</code> <code>getDictItemList/{code}</code></td><td>GET</td><td>分页 / 详情 / 按编码获取</td></tr><tr><td>字典项</td><td><code>/api/dict/item/add</code></td><td>POST</td><td>新增</td></tr><tr><td>字典项</td><td><code>/api/dict/item/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>字典项</td><td><code>/api/dict/item/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>字典项</td><td><code>/api/dict/item/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>配置</td><td><code>/api/config/page</code> <code>list</code> <code>detail/{id}</code> <code>web/index</code></td><td>GET</td><td>分页 / 全量 / 详情 / 网站配置</td></tr><tr><td>配置</td><td><code>/api/config/add</code> <code>web/save</code></td><td>POST</td><td>新增 / 保存网站配置</td></tr><tr><td>配置</td><td><code>/api/config/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>配置</td><td><code>/api/config/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>配置</td><td><code>/api/config/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>配置项</td><td><code>/api/config/item/page</code> <code>list</code> <code>detail/{id}</code></td><td>GET</td><td>分页 / 全量 / 详情</td></tr><tr><td>配置项</td><td><code>/api/config/item/add</code></td><td>POST</td><td>新增</td></tr><tr><td>配置项</td><td><code>/api/config/item/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>配置项</td><td><code>/api/config/item/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>配置项</td><td><code>/api/config/item/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>参数</td><td><code>/api/param/page</code> <code>list</code> <code>detail/{id}</code></td><td>GET</td><td>分页 / 全量 / 详情</td></tr><tr><td>参数</td><td><code>/api/param/add</code></td><td>POST</td><td>新增</td></tr><tr><td>参数</td><td><code>/api/param/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>参数</td><td><code>/api/param/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>参数</td><td><code>/api/param/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>城市</td><td><code>/api/city/list</code> <code>detail/{id}</code> <code>getCityList/{code}</code> <code>getParent/{id}</code> <code>findByParentCode</code></td><td>GET</td><td>列表 / 详情 / 级联查询</td></tr><tr><td>城市</td><td><code>/api/city/add</code></td><td>POST</td><td>新增</td></tr><tr><td>城市</td><td><code>/api/city/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>城市</td><td><code>/api/city/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>城市</td><td><code>/api/city/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr></tbody></table><h3 id="内容管理" tabindex="-1">内容管理 <a class="header-anchor" href="#内容管理" aria-label="Permalink to "内容管理""></a></h3><table tabindex="0"><thead><tr><th>模块</th><th>主要接口</th><th>方法</th><th>说明</th></tr></thead><tbody><tr><td>文章</td><td><code>/api/article/page</code> <code>list</code> <code>detail/{id}</code></td><td>GET</td><td>分页 / 全量 / 详情</td></tr><tr><td>文章</td><td><code>/api/article/add</code></td><td>POST</td><td>新增</td></tr><tr><td>文章</td><td><code>/api/article/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>文章</td><td><code>/api/article/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>文章</td><td><code>/api/article/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>分类</td><td><code>/api/category/list</code> <code>page</code> <code>detail/{id}</code></td><td>GET</td><td>树形 / 分页 / 详情</td></tr><tr><td>分类</td><td><code>/api/category/add</code></td><td>POST</td><td>新增</td></tr><tr><td>分类</td><td><code>/api/category/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>分类</td><td><code>/api/category/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>分类</td><td><code>/api/category/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>公告</td><td><code>/api/notice/page</code> <code>list</code> <code>detail/{id}</code></td><td>GET</td><td>分页 / 全量 / 详情</td></tr><tr><td>公告</td><td><code>/api/notice/add</code></td><td>POST</td><td>新增</td></tr><tr><td>公告</td><td><code>/api/notice/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>公告</td><td><code>/api/notice/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>公告</td><td><code>/api/notice/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>友链</td><td><code>/api/link/page</code> <code>list</code> <code>detail/{id}</code></td><td>GET</td><td>分页 / 全量 / 详情</td></tr><tr><td>友链</td><td><code>/api/link/add</code></td><td>POST</td><td>新增</td></tr><tr><td>友链</td><td><code>/api/link/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>友链</td><td><code>/api/link/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>友链</td><td><code>/api/link/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr></tbody></table><h3 id="监控管理" tabindex="-1">监控管理 <a class="header-anchor" href="#监控管理" aria-label="Permalink to "监控管理""></a></h3><table tabindex="0"><thead><tr><th>模块</th><th>主要接口</th><th>方法</th><th>说明</th></tr></thead><tbody><tr><td>定时任务</td><td><code>/api/job/page</code> <code>list</code> <code>detail/{id}</code></td><td>GET</td><td>分页 / 全量 / 详情</td></tr><tr><td>定时任务</td><td><code>/api/job/runOnce/{id}</code></td><td>GET</td><td>手动执行一次</td></tr><tr><td>定时任务</td><td><code>/api/job/pause/{id}</code> <code>resume/{id}</code> <code>daemonStatus</code></td><td>GET</td><td>暂停 / 恢复 / 守护进程状态</td></tr><tr><td>定时任务</td><td><code>/api/job/add</code> <code>status</code></td><td>POST</td><td>新增 / 设置状态</td></tr><tr><td>定时任务</td><td><code>/api/job/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>定时任务</td><td><code>/api/job/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>定时任务</td><td><code>/api/job/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>任务日志</td><td><code>/api/job/log/page</code> <code>detail/{id}</code></td><td>GET</td><td>日志分页 / 详情</td></tr><tr><td>任务日志</td><td><code>/api/job/log/batchDelete</code></td><td>DELETE</td><td>批量删除日志</td></tr><tr><td>任务日志</td><td><code>/api/job/log/delete/{id}</code></td><td>DELETE</td><td>删除日志</td></tr></tbody></table><h3 id="日志审计" tabindex="-1">日志审计 <a class="header-anchor" href="#日志审计" aria-label="Permalink to "日志审计""></a></h3><table tabindex="0"><thead><tr><th>模块</th><th>主要接口</th><th>方法</th><th>说明</th></tr></thead><tbody><tr><td>操作日志</td><td><code>/api/oper/log/page</code> <code>detail/{id}</code></td><td>GET</td><td>分页 / 详情</td></tr><tr><td>操作日志</td><td><code>/api/oper/log/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>操作日志</td><td><code>/api/oper/log/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>登录日志</td><td><code>/api/login/log/page</code> <code>detail/{id}</code></td><td>GET</td><td>分页 / 详情</td></tr><tr><td>登录日志</td><td><code>/api/login/log/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>登录日志</td><td><code>/api/login/log/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr></tbody></table><h3 id="示例与开发工具" tabindex="-1">示例与开发工具 <a class="header-anchor" href="#示例与开发工具" aria-label="Permalink to "示例与开发工具""></a></h3><table tabindex="0"><thead><tr><th>模块</th><th>主要接口</th><th>方法</th><th>说明</th></tr></thead><tbody><tr><td>示例</td><td><code>/api/example/page</code> <code>list</code> <code>detail/{id}</code> <code>export</code></td><td>GET</td><td>分页 / 全量 / 详情 / 导出</td></tr><tr><td>示例</td><td><code>/api/example/add</code> <code>import</code></td><td>POST</td><td>新增 / 导入</td></tr><tr><td>示例</td><td><code>/api/example/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>示例</td><td><code>/api/example/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>示例</td><td><code>/api/example/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>文件模板</td><td><code>/api/file/template/page</code> <code>detail/{id}</code> <code>getTemplateByCode/{code}</code></td><td>GET</td><td>分页 / 详情 / 按编码获取</td></tr><tr><td>文件模板</td><td><code>/api/file/template/add</code></td><td>POST</td><td>新增</td></tr><tr><td>文件模板</td><td><code>/api/file/template/batchDelete</code></td><td>DELETE</td><td>批量删除</td></tr><tr><td>文件模板</td><td><code>/api/file/template/update</code></td><td>PUT</td><td>修改</td></tr><tr><td>文件模板</td><td><code>/api/file/template/delete/{id}</code></td><td>DELETE</td><td>删除</td></tr><tr><td>代码生成</td><td><code>/api/generator/page</code> <code>preview</code></td><td>GET</td><td>可生成表列表 / 预览代码</td></tr><tr><td>代码生成</td><td><code>/api/generator/generate</code> <code>batchGenerate</code></td><td>POST</td><td>生成 / 批量生成</td></tr></tbody></table><h2 id="接口统计" tabindex="-1">接口统计 <a class="header-anchor" href="#接口统计" aria-label="Permalink to "接口统计""></a></h2><table tabindex="0"><thead><tr><th>分组</th><th>接口数量</th><th>说明</th></tr></thead><tbody><tr><td>公开接口</td><td>5</td><td>登录 / 刷新 / 验证码 / OAuth2</td></tr><tr><td>个人中心与公共</td><td>7</td><td>登出 / 用户信息 / 菜单 / 改密 / 改资料 / 上传 / 吊销</td></tr><tr><td>系统管理</td><td>~52</td><td>用户 / 角色 / 菜单 / 部门 / 岗位 / 职级 / 租户</td></tr><tr><td>数据管理</td><td>~50</td><td>字典 / 字典项 / 配置 / 配置项 / 参数 / 城市</td></tr><tr><td>内容管理</td><td>~28</td><td>文章 / 分类 / 公告 / 友链</td></tr><tr><td>监控管理</td><td>16</td><td>定时任务 / 任务日志</td></tr><tr><td>日志审计</td><td>8</td><td>操作日志 / 登录日志</td></tr><tr><td>示例与开发工具</td><td>~20</td><td>示例 / 文件模板 / 代码生成</td></tr><tr><td><strong>合计</strong></td><td><strong>≈180</strong></td><td>以 <code>php artisan route:list</code> 为准</td></tr></tbody></table><div class="tip custom-block"><p class="custom-block-title">动态获取</p><p>执行 <code>php artisan route:list</code> 可输出全部路由（方法、URI、中间件、控制器动作），是核对接口清单的最权威来源。详细清单见 <a href="/zh/appendix/api-cheatsheet.html">附录 E</a>。</p></div>`,33)])])}const T=d(i,[["render",c]]);export{E as __pageData,T as default};
|