Initial commit

web-admin/docs/system-inventory.md

@@ -0,0 +1,191 @@
+# 系统接口与功能梳理
+
+## 菜单结构
+
+后端默认菜单初始化文件：`server/source/system/menu.go`
+
+### 总览
+
+- `dashboard` 仪表盘
+- `about` 关于系统
+- `person` 个人中心
+- `state` 服务器状态
+
+### 超级管理员
+
+- `authority` 角色管理
+- `menu` 菜单管理
+- `api` API 管理
+- `user` 用户管理
+- `dictionary` 字典管理
+- `operation` 操作历史
+- `sysParams` 参数管理
+- `system` 系统配置
+- `apiToken` API Token
+- `loginLog` 登录日志
+- `sysVersion` 版本管理
+- `sysError` 错误日志
+
+### 示例模块
+
+- `breakpoint` 断点续传
+- `customer` 客户列表示例
+
+### 公共模块
+
+- `upload` 媒体库
+
+### 编程辅助
+
+- `autoPkg` 模板配置
+- `autoCode` 代码生成器
+- `autoCodeAdmin` 自动化代码管理
+- `formCreate` 表单生成器
+- `aiWorkflow` AI 需求工作流
+- `exportTemplate` 导出模板
+- `mcpTest` Mcp Tools 管理
+- `mcpTool` Mcp Tools 模板
+- `skills` Skills 管理
+- `picture` AI 页面绘制
+- `autoCodeEdit/:id` 隐藏编辑路由
+
+## 主要接口分组
+
+后端默认接口初始化文件：`server/source/system/api.go`
+
+### 认证与会话
+
+- `POST /base/login`
+- `POST /base/captcha`
+- `GET /user/getUserInfo`
+- `POST /jwt/jsonInBlacklist`
+- `POST /user/setUserAuthority`
+
+### 用户管理
+
+- `POST /user/getUserList`
+- `POST /user/admin_register`
+- `PUT /user/setUserInfo`
+- `POST /user/resetPassword`
+- `PUT /user/setSelfInfo`
+- `POST /user/changePassword`
+
+### 角色与权限
+
+- `POST /authority/getAuthorityList`
+- `POST /authority/createAuthority`
+- `PUT /authority/updateAuthority`
+- `POST /authority/deleteAuthority`
+- `POST /authority/copyAuthority`
+- `GET /authority/getUsersByAuthority`
+- `POST /authority/setRoleUsers`
+- `POST /menu/getMenuAuthority`
+- `POST /menu/addMenuAuthority`
+- `POST /casbin/getPolicyPathByAuthorityId`
+- `POST /casbin/updateCasbin`
+
+### 菜单管理
+
+- `POST /menu/getBaseMenuTree`
+- `POST /menu/getMenuList`
+- `POST /menu/addBaseMenu`
+- `POST /menu/updateBaseMenu`
+- `POST /menu/deleteBaseMenu`
+- `POST /menu/getBaseMenuById`
+- `GET /menu/getMenuRoles`
+- `POST /menu/setMenuRoles`
+
+### API 管理
+
+- `POST /api/getApiList`
+- `POST /api/getAllApis`
+- `POST /api/createApi`
+- `POST /api/updateApi`
+- `POST /api/deleteApi`
+- `POST /api/getApiById`
+- `GET /api/freshCasbin`
+- `GET /api/getApiRoles`
+- `POST /api/setApiRoles`
+
+### 字典与参数
+
+- `GET /sysDictionary/getSysDictionaryList`
+- `POST /sysDictionary/createSysDictionary`
+- `PUT /sysDictionary/updateSysDictionary`
+- `DELETE /sysDictionary/deleteSysDictionary`
+- `GET /sysDictionaryDetail/getDictionaryTreeList`
+- `POST /sysDictionaryDetail/createSysDictionaryDetail`
+- `PUT /sysDictionaryDetail/updateSysDictionaryDetail`
+- `DELETE /sysDictionaryDetail/deleteSysDictionaryDetail`
+- `GET /sysParams/getSysParamsList`
+- `POST /sysParams/createSysParams`
+- `PUT /sysParams/updateSysParams`
+- `DELETE /sysParams/deleteSysParams`
+
+### 审计与运维
+
+- `GET /sysLoginLog/getLoginLogList`
+- `DELETE /sysLoginLog/deleteLoginLog`
+- `DELETE /sysLoginLog/deleteLoginLogByIds`
+- `GET /sysOperationRecord/getSysOperationRecordList`
+- `DELETE /sysOperationRecord/deleteSysOperationRecord`
+- `DELETE /sysOperationRecord/deleteSysOperationRecordByIds`
+- `POST /system/getSystemConfig`
+- `POST /system/setSystemConfig`
+- `POST /system/reloadSystem`
+- `POST /system/getServerInfo`
+- `POST /sysApiToken/getApiTokenList`
+- `POST /sysApiToken/createApiToken`
+- `POST /sysApiToken/deleteApiToken`
+- `GET /sysError/getSysErrorList`
+- `PUT /sysError/updateSysError`
+- `DELETE /sysError/deleteSysError`
+- `GET /sysError/getSysErrorSolution`
+
+## React 新后台覆盖情况
+
+### 已做成可用页
+
+- 登录
+- 仪表盘
+- 用户管理
+- 角色管理
+- 菜单管理
+- API 管理
+- 字典管理
+- 参数管理
+- 登录日志
+- 操作历史
+- 系统配置
+- API Token
+- 错误日志
+- 个人中心
+- 服务器状态
+
+### 已做成模块入口页
+
+- 关于系统
+- 版本管理
+- 媒体库
+- 断点续传
+- 客户列表示例
+- 模板配置
+- 代码生成器
+- 自动化代码管理
+- 表单生成器
+- AI 需求工作流
+- 导出模板
+- Mcp Tools 管理
+- Mcp Tools 模板
+- Skills 管理
+- AI 页面绘制
+- 插件系统
+- 插件安装
+- 打包插件
+- 邮件插件
+- 公告管理
+
+## 说明
+
+- 新后台没有修改后端协议，仍然复用原有 token、菜单、权限和接口格式。
+- 当前仍有部分研发辅助类重模块保留为入口页，原因不是无法实现，而是这些模块交互面太大，适合单独拆阶段继续重构。