erp-java/services/system-tool-service/README.md

62 lines
2.6 KiB
Markdown

# System Tool Service
System tools module - configuration, logs, monitoring, data cleanup
## 基本信息
- **服务端口**: 8087
- **服务名称**: system-tool-service
- **模块分支**: 业务域/功能模块
- **数据库**: erp_db
## 功能清单
1. 系统监控
2. 操作日志
3. 运维工具
## API接口
| 方法 | 路径 | 描述 |
|------|------|------|
| GET | /api/system/logs/{id} | OperationLogController接口 |
| GET | /api/system/logs/statistics | OperationLogController接口 |
| GET | /api/system/logs/modules | OperationLogController接口 |
| GET | /api/system/logs/actions | OperationLogController接口 |
| GET | /api/system/logs/export | OperationLogController接口 |
| POST | /api/system/logs/batch-delete | OperationLogController接口 |
| DELETE | /api/system/logs/{id} | OperationLogController接口 |
| DELETE | /api/system/logs/clear | OperationLogController接口 |
| GET | /api/system/audit-logs/{id} | AuditLogController接口 |
| GET | /api/system/audit-logs/stats | AuditLogController接口 |
| DELETE | /api/system/audit-logs/clear | AuditLogController接口 |
| GET | /api/system/monitoring/api-stats | MonitoringController接口 |
| GET | /api/system/monitoring/queue-backlog | MonitoringController接口 |
| GET | /api/system/monitoring/health | MonitoringController接口 |
| POST | /api/system/monitoring/alert | MonitoringController接口 |
| POST | /api/system/monitoring/record | MonitoringController接口 |
| GET | /api/system/cleanup/status | DataCleanupController接口 |
| POST | /api/system/cleanup/pull-records | DataCleanupController接口 |
| POST | /api/system/cleanup/operation-logs | DataCleanupController接口 |
| POST | /api/system/cleanup/audit-logs | DataCleanupController接口 |
| POST | /api/system/cleanup/full | DataCleanupController接口 |
| GET | /api/system/consistency/full-check | DataConsistencyController接口 |
| GET | /api/system/consistency/stock | DataConsistencyController接口 |
| GET | /api/system/consistency/order-stock | DataConsistencyController接口 |
| GET | /api/system/consistency/waybill | DataConsistencyController接口 |
| GET | /api/system/consistency/finance | DataConsistencyController接口 |
| GET | /api/system/configs/{group} | SystemConfigController接口 |
| GET | /api/system/configs/{group}/{key} | SystemConfigController接口 |
| POST | /api/system/configs/batch | SystemConfigController接口 |
## 数据库表
| 表名 | 说明 |
|------|------|
| system_tool_service_table | 说明 |
## 配置文件
- bootstrap.yml: Nacos配置
- application.yml: 应用配置
## 启动方式
```bash
mvn clean package
java -jar target/system-tool-service.jar
```