================================================================================ EasyGoAdmin 后端开发者文档 · 11 API 接口清单 ================================================================================ 来源：api/v1/*.go 的 gmeta 注解全量提取（与运行时路由一致）。 说明： * 全部路由无 /v1 版本段，统一 /api 前缀。 * “权限”列为空表示登录即可（permission 标签为空）；公开表示免登录 （须与 middleware/public.go 白名单一致）。 * 每个接口的操作日志标题/类型见 gmeta log/logType（下文按模块给出规律： 七件套日志标题 = "{模块中文名}-查询分页记录/查询列表/查询详情/新增记录/ 修改记录/删除记录/批量删除记录/导入数据/导出数据/设置状态"）。 * 完整 OpenAPI：GET /api.json；在线调试：GET /swagger。 -------------------------------------------------------------------------------- auth 认证（公开/顶层） -------------------------------------------------------------------------------- POST /api/login 公开 登录（写登录日志） GET /api/logout 登出（拉黑 jti） GET /api/captcha 公开 图形验证码 POST /api/oauth2/token 公开 刷新令牌/密码模式兑换（轮换） GET /api/oauth2/check/token 校验令牌有效性 DELETE /api/oauth2/remove/:token 撤销指定令牌（踢下线） （POST /api/register 在白名单中放行，路由未注册——启用时补实现） -------------------------------------------------------------------------------- index 个人中心（登录即可） -------------------------------------------------------------------------------- GET /api/index/getUser 当前用户信息（超管返回 *:*:*） GET /api/index/getMenus 当前用户菜单树 GET /api/index/getMenus/:id 同上（menu 页面调用） PUT /api/index/updatePassword 修改个人密码（旧密码校验） PUT /api/index/updateProfile 更新个人信息 -------------------------------------------------------------------------------- system 域 -------------------------------------------------------------------------------- user（/api/user，perm sys:user:*） GET /api/user/page sys:user:page GET /api/user/list sys:user:list GET /api/user/detail/:id sys:user:detail POST /api/user/add sys:user:add PUT /api/user/update sys:user:update PUT /api/user/status sys:user:status PUT /api/user/resetPwd sys:user:resetPwd 重置密码（logType reset） DELETE /api/user/delete/:id sys:user:delete DELETE /api/user/batchDelete sys:user:batchDelete POST /api/user/import sys:user:import Excel 导入（logType import） GET /api/user/export sys:user:export Excel 导出（logType export） GET /api/user/document/:id sys:user:detail 打印信息 role（/api/role） 七件套 sys:role:{page|list|detail|add|update|delete|batchDelete} GET /api/role/menu/list/:roleId sys:role:getPermission 查询角色菜单 POST /api/role/menu/save sys:role:savePermission 保存权限 报文字段：Add/Update 含 dataScope（1-全部 2-本部门及以下 3-本部门 4-仅本人， gvalid in:1,2,3,4 校验，缺省归一 1）；Page/Detail 返回 dataScope + dataScopeText（字典 role_data_scope 驱动）。机制见 03 章第 6 节。 menu（/api/menu，List 返回树形） 七件套 sys:menu:{page|list|detail|add|update|delete|batchDelete} dept（/api/dept，List 返回树形；删除有子级/用户守卫） 七件套 sys:dept:* level（/api/level，含状态与导入导出） 七件套 + PUT /api/level/status（sys:level:status） POST /api/level/import sys:level:import GET /api/level/export sys:level:export position（/api/position） 七件套 + PUT /api/position/status（sys:position:status） tenant（/api/tenant） 七件套 + PUT /api/tenant/status（sys:tenant:status） POST /api/tenant/account sys:tenant:add 创建租户账号（开户） GET /api/tenant/users/:tenantId sys:tenant:users 查询租户用户 -------------------------------------------------------------------------------- data 域 -------------------------------------------------------------------------------- config（/api/config） 七件套 sys:config:* GET /api/config/web/index sys:configWeb:data 获取网站配置 POST /api/config/web/save sys:configWeb:save 保存网站配置 config_item（/api/config/item） 七件套 sys:configitem:* param（/api/param） 七件套 sys:param:* dict（/api/dict） 七件套 sys:dict:*（注：无 /dict/list，列表经 page/别名） GET /api/dict/refreshCache sys:dict:cache 刷新字典缓存 GET /api/dictionary/list 登录即可 字典列表别名（前端 dictionary.ts） GET /api/dictionary/info 登录即可 字典详情别名 dict_item（/api/dict/item） 七件套 sys:dictitem:* GET /api/dict/item/getDictItemList/:code 登录即可 按编码查字典项（缓存） notice（/api/notice） 七件套 + PUT /api/notice/status（sys:notice:status） city（/api/city，别名 /api/area） 七件套 sys:city:* GET /api/city/getCityList/:parentCode 登录即可 下级城市（级联懒加载） GET /api/area/getParent 登录即可 省份列表 GET /api/area/findByParentCode 登录即可 按父编码查城市 -------------------------------------------------------------------------------- content 域 -------------------------------------------------------------------------------- article（/api/article） 七件套 + PUT /api/article/status（sys:article:status） category（/api/category，List 返回树形） 七件套 sys:category:* link（/api/link） 七件套 sys:link:*（无 status） -------------------------------------------------------------------------------- monitor 域 -------------------------------------------------------------------------------- operation_log（/api/oper/log，仅查询与删除） GET /page /list /detail/:id、DELETE /delete/:id /batchDelete sys:operLog:* login_log（/api/login/log）同上五件 sys:loginLog:* job_log（/api/job/log）同上五件 sys:jobLog:* job（/api/job） 七件套 sys:job:* GET /api/job/runOnce/:id sys:job:execute 立即执行（异步） GET /api/job/pause/:id sys:job:pause GET /api/job/resume/:id sys:job:resume POST /api/job/status sys:job:update GET /api/job/daemonStatus 登录即可 调度器状态 online_user（/api/onlineUser，无表） GET /api/onlineUser/page sys:onlineUser:page GET /api/onlineUser/detail/:id sys:onlineUser:detail GET /api/onlineUser/forceLogout/:id sys:onlineUser:forceLogout GET /api/onlineUser/forceLogoutUser/:userId sys:onlineUser:forceLogout server_monitor（无表） GET /api/server/info 登录即可 服务器监控信息 cache_monitor（无表） GET /api/cache/info 登录即可 缓存监控信息 -------------------------------------------------------------------------------- tool 域 -------------------------------------------------------------------------------- example（/api/example，导入导出演示） 七件套 + PUT /api/example/status（sys:example:status） POST /api/example/import sys:example:import GET /api/example/export sys:example:export file_template（/api/file/template） 七件套 sys:fileTemplate:* GET /api/file/template/getTemplateByCode/:code 登录即可 按编码查模板 generator（/api/generator） GET /api/generator/page sys:generator:page 数据表清单 POST /api/generator/preview sys:generator:generator 预览代码 POST /api/generator/generate sys:generator:generator 一键生成 POST /api/generator/batchGenerate sys:generator:batchGenerator 批量生成 upload（/api/upload） POST /api/upload/uploadFile sys:upload:file 上传（multipart file） POST /api/upload/uploadFiles sys:upload:files 批量上传 -------------------------------------------------------------------------------- 基础设施（router.go 手工注册） -------------------------------------------------------------------------------- GET /api/health 公开 健康检查 {"status":"up"} GET /swagger 公开 本地 API 文档页（重定向 Redoc） GET /api.json 公开 OpenAPI JSON GET /upload/** 静态文件（SetServerRoot resource） -------------------------------------------------------------------------------- 权限码总规律 -------------------------------------------------------------------------------- sys:{模块小驼峰}:{动作}；动作与方法名一致：page/list/detail/add/update/delete/ batchDelete/status/import/export/resetPwd/execute/pause/resume/savePermission/ getPermission/cache/users/save 等。 特例：配置网站 sys:configWeb:data|save；生成器 sys:generator:generator| batchGenerator；上传 sys:upload:file|files。 超管（ROLE_SUPER_ADMIN）绕过全部权限校验。