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(`

8.7 API 接口总览 ​

概述

本节按模块分组列出所有 API 接口的概述，详细路由清单见附录 E。

API 设计规范 ​

命名规范 ​

规范说明示例
URL 风格RESTful，小写下划线/api/user/page
模块名与 Controller 对应user、article、dict
操作名标准 CRUD 动词page、list、detail、add、update、delete、batchDelete
扩展操作业务动词import、export、resetPwd、refreshCache

HTTP 方法规范 ​

操作HTTP 方法URL 示例说明
分页查询GET/api/user/page参数在 URL query string
全量列表GET/api/user/list参数在 URL query string
详情GET/api/user/detail/{id}ID 在 URL 路径
新增POST/api/user/add参数在 JSON 请求体
修改PUT/api/user/update参数在 JSON 请求体（含 id）
删除DELETE/api/user/delete/{id}ID 在 URL 路径
批量删除DELETE/api/user/batchDeleteids 在 JSON 请求体

统一响应格式 ​

json
{
    "code": 0,       // 0=成功，其他=失败
    "ok": true,      // 是否成功
    "msg": "操作成功", // 提示信息
    "data": {}       // 响应数据
}

认证方式 ​

text
Authorization: Bearer <access_token>

公开接口（无需认证） ​

模块接口方法说明
登录/api/loginPOST用户登录，返回双令牌
登出/api/logoutGET用户登出（记录日志）
验证码/api/captchaGET获取图片验证码
Token/api/oauth2/tokenPOST获取/刷新 Token
Token/api/oauth2/check/tokenGET检查 Token 有效性
Token/api/oauth2/remove/{token}DELETE吊销 Token

系统管理 ​

模块主要接口方法说明
首页/api/index/getUserInfoGET获取当前用户信息
首页/api/index/getMenusGET获取菜单树（动态路由）
首页/api/index/updatePwdPUT修改密码
用户/api/user/pageGET用户分页列表
用户/api/user/detail/{id}GET用户详情
用户/api/user/addPOST新增用户
用户/api/user/updatePUT修改用户
用户/api/user/delete/{id}DELETE删除用户
用户/api/user/batchDeleteDELETE批量删除用户
用户/api/user/resetPwdPOST重置密码
用户/api/user/importPOSTExcel 导入用户
用户/api/user/exportGETExcel 导出用户
角色/api/role/pageGET角色分页列表
角色/api/role/addPOST新增角色（含菜单权限）
角色/api/role/updatePUT修改角色（含菜单权限）
角色/api/role/delete/{id}DELETE删除角色
角色/api/role/menus/{id}GET获取角色的菜单 ID 列表
菜单/api/menu/treeListGET菜单树形列表
菜单/api/menu/addPOST新增菜单
菜单/api/menu/updatePUT修改菜单
菜单/api/menu/delete/{id}DELETE删除菜单
部门/api/dept/treeListGET部门树形列表
部门/api/dept/addPOST新增部门
部门/api/dept/updatePUT修改部门
部门/api/dept/delete/{id}DELETE删除部门
岗位/api/position/pageGET岗位分页列表
岗位/api/position/addPOST新增岗位
岗位/api/position/updatePUT修改岗位
岗位/api/position/delete/{id}DELETE删除岗位
职级/api/level/pageGET职级分页列表
职级/api/level/addPOST新增职级
职级/api/level/updatePUT修改职级
职级/api/level/delete/{id}DELETE删除职级
职级/api/level/importPOSTExcel 导入职级
职级/api/level/exportGETExcel 导出职级
租户/api/tenant/pageGET租户分页列表
租户/api/tenant/detail/{id}GET租户详情
租户/api/tenant/addPOST新增租户
租户/api/tenant/updatePUT修改租户
租户/api/tenant/delete/{id}DELETE删除租户
租户/api/tenant/accountPOST创建租户管理员账号
租户/api/tenant/users/{tenantId}GET获取租户用户列表

数据管理 ​

模块主要接口方法说明
字典/api/dict/pageGET字典分页列表
字典/api/dict/addPOST新增字典
字典/api/dict/updatePUT修改字典
字典/api/dict/delete/{id}DELETE删除字典
字典/api/dict/refreshCacheGET刷新字典缓存
字典项/api/dict/item/pageGET字典项分页列表
字典项/api/dict/item/addPOST新增字典项
字典项/api/dict/item/updatePUT修改字典项
字典项/api/dict/item/delete/{id}DELETE删除字典项
字典项/api/dict/item/getDictItemList/{code}GET按编码获取字典项列表
配置/api/config/pageGET配置分页列表
配置/api/config/addPOST新增配置组
配置/api/config/updatePUT修改配置组
配置/api/config/delete/{id}DELETE删除配置组
配置项/api/config/item/pageGET配置项分页列表
配置项/api/config/item/addPOST新增配置项
配置项/api/config/item/updatePUT修改配置项
配置项/api/config/item/delete/{id}DELETE删除配置项
参数/api/param/pageGET参数分页列表
参数/api/param/addPOST新增参数
参数/api/param/updatePUT修改参数
参数/api/param/delete/{id}DELETE删除参数
公告/api/notice/pageGET公告分页列表
公告/api/notice/addPOST新增公告
公告/api/notice/updatePUT修改公告
公告/api/notice/delete/{id}DELETE删除公告
城市/api/city/listGET城市列表
城市/api/city/addPOST新增城市
城市/api/city/updatePUT修改城市
城市/api/city/delete/{id}DELETE删除城市
城市/api/city/getCityList/{parentCode}GET按父编码查询下级城市
城市/api/city/getParentGET获取省份列表

内容管理 ​

模块主要接口方法说明
文章/api/article/pageGET文章分页列表
文章/api/article/detail/{id}GET文章详情
文章/api/article/addPOST新增文章
文章/api/article/updatePUT修改文章
文章/api/article/delete/{id}DELETE删除文章
文章/api/article/batchDeleteDELETE批量删除文章
分类/api/category/treeListGET分类树形列表
分类/api/category/addPOST新增分类
分类/api/category/updatePUT修改分类
分类/api/category/delete/{id}DELETE删除分类
链接/api/link/pageGET链接分页列表
链接/api/link/addPOST新增链接
链接/api/link/updatePUT修改链接
链接/api/link/delete/{id}DELETE删除链接

监控管理 ​

模块主要接口方法说明
定时任务/api/job/pageGET任务分页列表
定时任务/api/job/addPOST新增任务
定时任务/api/job/updatePUT修改任务
定时任务/api/job/delete/{id}DELETE删除任务
定时任务/api/job/run/{id}POST手动执行任务
定时任务/api/job/pause/{id}POST暂停任务
定时任务/api/job/resume/{id}POST恢复任务
任务日志/api/job/log/pageGET任务日志分页列表
任务日志/api/job/log/delete/{id}DELETE删除日志
任务日志/api/job/log/batchDeleteDELETE批量删除日志

日志审计 ​

模块主要接口方法说明
操作日志/api/oper/log/pageGET操作日志分页列表
操作日志/api/oper/log/detail/{id}GET日志详情
操作日志/api/oper/log/delete/{id}DELETE删除日志
操作日志/api/oper/log/batchDeleteDELETE批量删除日志
登录日志/api/login/log/pageGET登录日志分页列表
登录日志/api/login/log/detail/{id}GET日志详情
登录日志/api/login/log/delete/{id}DELETE删除日志
登录日志/api/login/log/batchDeleteDELETE批量删除日志

公共接口 ​

模块接口方法说明
文件上传/api/upload/uploadFilePOST上传文件（type=file/image）
代码生成/api/generator/pageGET可生成的表列表
代码生成/api/generator/previewPOST预览生成代码
代码生成/api/generator/generatePOST执行代码生成

接口统计 ​

模块接口数量说明
公开接口6登录/登出/验证码/Token
系统管理~35用户/角色/菜单/部门/岗位/职级/租户
数据管理~25字典/字典项/配置/配置项/参数/公告/城市
内容管理~12文章/分类/链接
监控管理~10定时任务/任务日志
日志审计~8操作日志/登录日志
公共接口~4文件上传/代码生成
合计~100

详细路由清单（HTTP 方法 + 路径 + 权限码）见附录 E。

`,28)])])}const T=d(o,[["render",r]]);export{E as __pageData,T as default};