From c115a0b58c5910fe7fbba5842fa0b00142dd227f Mon Sep 17 00:00:00 2001 From: zhangjf Date: Mon, 16 Feb 2026 09:08:36 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=90=8C=E6=AD=A5=E6=93=8D=E4=BD=9C?= =?UTF-8?q?=E6=97=A5=E5=BF=97=E7=AE=A1=E7=90=86=E6=A8=A1=E5=9D=97=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 更新内容： 1. API接口文档.md - 新增「十一、操作日志管理接口」章节（165行） - 4个核心接口文档： * 11.1 获取操作日志列表（分页+多条件过滤） * 11.2 获取操作日志详情 * 11.3 删除操作日志 * 11.4 批量删除操作日志 - 11.5 操作类型说明表（8种操作类型+标签颜色） - 完整的请求参数、响应示例、字段说明 - 时间格式说明（yyyy-MM-dd HH:mm:ss） - 调整附录章节编号为「十二」 2. 资金服务平台 FundPlatform 功能清单.md - 标记「操作日志记录与查询」为已完成 ✅ - 添加实现状态说明： * 后端：OperationLogMapper + OperationLogService + OperationLogController * 前端：operationLog.js + operationLog.vue * 功能清单：7大功能点 * 操作类型：8种类型（查询/新增/更新/删除/导入/导出/登录/登出） * 性能监控：执行时长超时标红 文档与代码同步完成！ --- doc/API接口文档.md | 166 +++++++++++++++++++++- doc/资金服务平台 FundPlatform 功能清单.md | 13 +- 2 files changed, 176 insertions(+), 3 deletions(-) diff --git a/doc/API接口文档.md b/doc/API接口文档.md index cadb7d7..5d9df4d 100644 --- a/doc/API接口文档.md +++ b/doc/API接口文档.md @@ -1368,9 +1368,171 @@ X-Tenant-Id: 1 --- -## 十一、附录 +## 十一、操作日志管理接口 -### 11.1 枚举值定义 +### 11.1 获取操作日志列表 + +**接口地址：** `GET /api/v1/operation-log/list` + +**接口说明：** 分页查询操作日志列表，支持多条件过滤 + +**请求参数：** + +| 参数名 | 类型 | 必填 | 说明 | +|--------|------|------|------| +| current | Long | 否 | 当前页码，默认1 | +| size | Long | 否 | 每页条数，默认10 | +| module | String | 否 | 模块名称（模糊查询） | +| operationType | String | 否 | 操作类型（SELECT/INSERT/UPDATE/DELETE/IMPORT/EXPORT/LOGIN/LOGOUT） | +| operatorId | Long | 否 | 操作人ID | +| startTime | DateTime | 否 | 开始时间（格式：yyyy-MM-dd HH:mm:ss） | +| endTime | DateTime | 否 | 结束时间（格式：yyyy-MM-dd HH:mm:ss） | + +**响应示例：** + +```json +{ + "code": 200, + "message": "操作成功", + "data": { + "records": [ + { + "logId": 1, + "tenantId": 1, + "module": "用户管理", + "operationType": "INSERT", + "description": "创建用户", + "requestMethod": "POST", + "requestUrl": "/api/v1/user", + "requestParams": "{\"username\":\"test\"}", + "responseResult": "{\"code\":200}", + "executionTime": 150, + "operatorId": 1, + "operatorName": "admin", + "operatorIp": "192.168.1.100", + "operatorLocation": "北京市", + "status": 1, + "errorMsg": null, + "createdTime": "2026-02-13 10:00:00" + } + ], + "total": 100, + "size": 10, + "current": 1 + } +} +``` + +--- + +### 11.2 获取操作日志详情 + +**接口地址：** `GET /api/v1/operation-log/{logId}` + +**接口说明：** 根据ID查询操作日志详情 + +**路径参数：** + +| 参数名 | 类型 | 必填 | 说明 | +|--------|------|------|------| +| logId | Long | 是 | 日志ID | + +**响应示例：** + +```json +{ + "code": 200, + "message": "操作成功", + "data": { + "logId": 1, + "tenantId": 1, + "module": "用户管理", + "operationType": "INSERT", + "description": "创建用户", + "requestMethod": "POST", + "requestUrl": "/api/v1/user", + "requestParams": "{\"username\":\"test\",\"email\":\"test@example.com\"}", + "responseResult": "{\"code\":200,\"message\":\"操作成功\"}", + "executionTime": 150, + "operatorId": 1, + "operatorName": "admin", + "operatorIp": "192.168.1.100", + "operatorLocation": "北京市", + "status": 1, + "errorMsg": null, + "createdTime": "2026-02-13 10:00:00" + } +} +``` + +--- + +### 11.3 删除操作日志 + +**接口地址：** `DELETE /api/v1/operation-log/{logId}` + +**接口说明：** 删除指定的操作日志 + +**路径参数：** + +| 参数名 | 类型 | 必填 | 说明 | +|--------|------|------|------| +| logId | Long | 是 | 日志ID | + +**响应示例：** + +```json +{ + "code": 200, + "message": "删除成功", + "data": null +} +``` + +--- + +### 11.4 批量删除操作日志 + +**接口地址：** `DELETE /api/v1/operation-log/batch` + +**接口说明：** 批量删除指定天数之前的操作日志 + +**请求参数：** + +| 参数名 | 类型 | 必填 | 说明 | +|--------|------|------|------| +| days | Long | 是 | 天数（删除N天前的日志，建议7-365） | + +**响应示例：** + +```json +{ + "code": 200, + "message": "批量删除成功", + "data": null +} +``` + +--- + +### 11.5 操作类型说明 + +| 操作类型 | 说明 | 标签颜色 | +|----------|------|----------| +| SELECT | 查询操作 | 默认 | +| INSERT | 新增操作 | 绿色 | +| UPDATE | 更新操作 | 橙色 | +| DELETE | 删除操作 | 红色 | +| IMPORT | 导入操作 | 灰色 | +| EXPORT | 导出操作 | 灰色 | +| LOGIN | 登录操作 | 绿色 | +| LOGOUT | 登出操作 | 灰色 | + +--- + +## 十二、附录 + +### 12.1 枚举值定义 #### 性别（gender） diff --git a/doc/资金服务平台 FundPlatform 功能清单.md b/doc/资金服务平台 FundPlatform 功能清单.md index 87697f3..59cb07c 100644 --- a/doc/资金服务平台 FundPlatform 功能清单.md +++ b/doc/资金服务平台 FundPlatform 功能清单.md @@ -6,7 +6,18 @@ - 用户注册/登录/注销 - 用户信息维护（姓名、手机号、邮箱、部门等） - 角色权限管理（管理员、财务、项目经理、普通员工） -- 操作日志记录与查询 +- 操作日志记录与查询 ✅ + - **实现状态**：✅ 已完成 + - 后端：OperationLogMapper + OperationLogService + OperationLogController + - 前端：operationLog.js + operationLog.vue + - 功能： + * 分页查询（支持模块、操作类型、操作人、时间范围过滤） + * 查询详情（完整展示请求参数、响应结果、错误信息） + * 删除单条日志 + * 批量删除（删除N天前的所有日志，支持7-365天） + * 操作类型：查询/新增/更新/删除/导入/导出/登录/登出 + * 执行时长监控（超时标红>1000ms） + * 状态展示（成功/失败） #### 4.1.2 组织架构管理 - 部门管理（增删改查、层级关系）