7 lines
21 KiB
JavaScript
7 lines
21 KiB
JavaScript
import{_ as d,o as e,c as a,a2 as i}from"./chunks/framework.B-QBKwc1.js";const E=JSON.parse('{"title":"API 接口总览","description":"本节按模块分组列出所有 API 接口的概述，详细路由清单见附录 E。","frontmatter":{},"headers":[],"relativePath":"zh/api-spec/overview.md","filePath":"zh/api-spec/overview.md"}'),o={name:"zh/api-spec/overview.md"};function r(c,t,s,p,h,l){return e(),a("div",null,[...t[0]||(t[0]=[i(`<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 接口的概述，详细路由清单见<a href="/zh/appendix/api-cheatsheet.html">附录 E</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>RESTful，小写下划线</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></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/user/list</code></td><td>参数在 URL query string</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>DELETE</td><td><code>/api/user/batchDelete</code></td><td>ids 在 JSON 请求体</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><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/logout</code></td><td>GET</td><td>用户登出（记录日志）</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>获取/刷新 Token</td></tr><tr><td>Token</td><td><code>/api/oauth2/check/token</code></td><td>GET</td><td>检查 Token 有效性</td></tr><tr><td>Token</td><td><code>/api/oauth2/remove/{token}</code></td><td>DELETE</td><td>吊销 Token</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><th>说明</th></tr></thead><tbody><tr><td>首页</td><td><code>/api/index/getUserInfo</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/updatePwd</code></td><td>PUT</td><td>修改密码</td></tr><tr><td>用户</td><td><code>/api/user/page</code></td><td>GET</td><td>用户分页列表</td></tr><tr><td>用户</td><td><code>/api/user/detail/{id}</code></td><td>GET</td><td>用户详情</td></tr><tr><td>用户</td><td><code>/api/user/add</code></td><td>POST</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/delete/{id}</code></td><td>DELETE</td><td>删除用户</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/resetPwd</code></td><td>POST</td><td>重置密码</td></tr><tr><td>用户</td><td><code>/api/user/import</code></td><td>POST</td><td>Excel 导入用户</td></tr><tr><td>用户</td><td><code>/api/user/export</code></td><td>GET</td><td>Excel 导出用户</td></tr><tr><td>角色</td><td><code>/api/role/page</code></td><td>GET</td><td>角色分页列表</td></tr><tr><td>角色</td><td><code>/api/role/add</code></td><td>POST</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/menus/{id}</code></td><td>GET</td><td>获取角色的菜单 ID 列表</td></tr><tr><td>菜单</td><td><code>/api/menu/treeList</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/treeList</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/position/page</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/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/level/page</code></td><td>GET</td><td>职级分页列表</td></tr><tr><td>职级</td><td><code>/api/level/add</code></td><td>POST</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></td><td>DELETE</td><td>删除职级</td></tr><tr><td>职级</td><td><code>/api/level/import</code></td><td>POST</td><td>Excel 导入职级</td></tr><tr><td>职级</td><td><code>/api/level/export</code></td><td>GET</td><td>Excel 导出职级</td></tr><tr><td>租户</td><td><code>/api/tenant/page</code></td><td>GET</td><td>租户分页列表</td></tr><tr><td>租户</td><td><code>/api/tenant/detail/{id}</code></td><td>GET</td><td>租户详情</td></tr><tr><td>租户</td><td><code>/api/tenant/add</code></td><td>POST</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/account</code></td><td>POST</td><td>创建租户管理员账号</td></tr><tr><td>租户</td><td><code>/api/tenant/users/{tenantId}</code></td><td>GET</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><th>说明</th></tr></thead><tbody><tr><td>字典</td><td><code>/api/dict/page</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/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>刷新字典缓存</td></tr><tr><td>字典项</td><td><code>/api/dict/item/page</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/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/dict/item/getDictItemList/{code}</code></td><td>GET</td><td>按编码获取字典项列表</td></tr><tr><td>配置</td><td><code>/api/config/page</code></td><td>GET</td><td>配置分页列表</td></tr><tr><td>配置</td><td><code>/api/config/add</code></td><td>POST</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></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/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></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/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/notice/page</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/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/city/list</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/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><tr><td>城市</td><td><code>/api/city/getCityList/{parentCode}</code></td><td>GET</td><td>按父编码查询下级城市</td></tr><tr><td>城市</td><td><code>/api/city/getParent</code></td><td>GET</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><th>说明</th></tr></thead><tbody><tr><td>文章</td><td><code>/api/article/page</code></td><td>GET</td><td>文章分页列表</td></tr><tr><td>文章</td><td><code>/api/article/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/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/article/batchDelete</code></td><td>DELETE</td><td>批量删除文章</td></tr><tr><td>分类</td><td><code>/api/category/treeList</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/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/link/page</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/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><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/job/page</code></td><td>GET</td><td>任务分页列表</td></tr><tr><td>定时任务</td><td><code>/api/job/add</code></td><td>POST</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/run/{id}</code></td><td>POST</td><td>手动执行任务</td></tr><tr><td>定时任务</td><td><code>/api/job/pause/{id}</code></td><td>POST</td><td>暂停任务</td></tr><tr><td>定时任务</td><td><code>/api/job/resume/{id}</code></td><td>POST</td><td>恢复任务</td></tr><tr><td>任务日志</td><td><code>/api/job/log/page</code></td><td>GET</td><td>任务日志分页列表</td></tr><tr><td>任务日志</td><td><code>/api/job/log/delete/{id}</code></td><td>DELETE</td><td>删除日志</td></tr><tr><td>任务日志</td><td><code>/api/job/log/batchDelete</code></td><td>DELETE</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><th>说明</th></tr></thead><tbody><tr><td>操作日志</td><td><code>/api/oper/log/page</code></td><td>GET</td><td>操作日志分页列表</td></tr><tr><td>操作日志</td><td><code>/api/oper/log/detail/{id}</code></td><td>GET</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/oper/log/batchDelete</code></td><td>DELETE</td><td>批量删除日志</td></tr><tr><td>登录日志</td><td><code>/api/login/log/page</code></td><td>GET</td><td>登录日志分页列表</td></tr><tr><td>登录日志</td><td><code>/api/login/log/detail/{id}</code></td><td>GET</td><td>日志详情</td></tr><tr><td>登录日志</td><td><code>/api/login/log/delete/{id}</code></td><td>DELETE</td><td>删除日志</td></tr><tr><td>登录日志</td><td><code>/api/login/log/batchDelete</code></td><td>DELETE</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><th>说明</th></tr></thead><tbody><tr><td>文件上传</td><td><code>/api/upload/uploadFile</code></td><td>POST</td><td>上传文件（type=file/image）</td></tr><tr><td>代码生成</td><td><code>/api/generator/page</code></td><td>GET</td><td>可生成的表列表</td></tr><tr><td>代码生成</td><td><code>/api/generator/preview</code></td><td>POST</td><td>预览生成代码</td></tr><tr><td>代码生成</td><td><code>/api/generator/generate</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>6</td><td>登录/登出/验证码/Token</td></tr><tr><td>系统管理</td><td>~35</td><td>用户/角色/菜单/部门/岗位/职级/租户</td></tr><tr><td>数据管理</td><td>~25</td><td>字典/字典项/配置/配置项/参数/公告/城市</td></tr><tr><td>内容管理</td><td>~12</td><td>文章/分类/链接</td></tr><tr><td>监控管理</td><td>~10</td><td>定时任务/任务日志</td></tr><tr><td>日志审计</td><td>~8</td><td>操作日志/登录日志</td></tr><tr><td>公共接口</td><td>~4</td><td>文件上传/代码生成</td></tr><tr><td><strong>合计</strong></td><td><strong>~100</strong></td><td></td></tr></tbody></table><p>详细路由清单（HTTP 方法 + 路径 + 权限码）见<a href="/zh/appendix/api-cheatsheet.html">附录 E</a>。</p>`,28)])])}const T=d(o,[["render",r]]);export{E as __pageData,T as default};
|