prod_ts/README.md

111 lines
3.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 信息管理系统IMS演示工程
## 项目简介
本工程是基于 Spring Boot 3.x 构建的信息管理系统IMS后端单体演示项目。
采用内存假数据实现业务逻辑,无需外部数据库即可编译运行。
集成 Knife4j 提供接口文档与调试界面。
## 技术栈
- Java 17
- Spring Boot 3.2.5
- Knife4j (OpenAPI 3) 4.5.0
- Maven
- BCrypt 密码加密
- Lombok
## 启动方式
```bash
# 1. 进入项目目录
cd codegen-runs/codegen_7a0450aa5ed043b8b81b0c627e7e16c7
# 2. 编译并启动
mvn clean package -DskipTests
java -jar target/ims-demo-1.0.0.jar
# 或直接使用 Maven 插件启动
mvn spring-boot:run
```
## 接口文档访问地址
启动后访问以下地址:
| 文档类型 | 访问地址 |
|----------|----------|
| Knife4j UI (推荐) | http://localhost:8080/doc.html |
| Swagger UI | http://localhost:8080/swagger-ui/index.html |
| OpenAPI JSON | http://localhost:8080/v3/api-docs |
## 功能模块与接口列表
### 1. 用户与权限管理
| 接口 | 方法 | 说明 |
|------|------|------|
| /api/user | POST | 新增用户 |
| /api/user/{id} | PUT | 编辑用户 |
| /api/user/{id} | DELETE | 删除用户 |
| /api/user | GET | 查询用户列表(支持 keyword, page, size |
| /api/user/{id} | GET | 查询用户详情 |
| /api/role | POST | 新增角色 |
| /api/role/{id} | PUT | 编辑角色 |
| /api/role/{id} | DELETE | 删除角色 |
| /api/role | GET | 查询角色列表 |
| /api/role/{id}/permissions | PUT | 分配角色权限 |
| /api/dept | POST | 新增部门 |
| /api/dept/{id} | PUT | 编辑部门 |
| /api/dept/{id} | DELETE | 删除部门 |
| /api/dept | GET | 查询部门列表(树形结构) |
### 2. 业务数据管理
| 接口 | 方法 | 说明 |
|------|------|------|
| /api/business | POST | 新增业务数据 |
| /api/business/{id} | PUT | 编辑业务数据 |
| /api/business/{id} | DELETE | 删除业务数据 |
| /api/business/{id}/submit | PUT | 提交审核 |
| /api/business/{id}/approve | PUT | 审核通过 |
| /api/business/{id}/reject | PUT | 驳回 |
| /api/business/{id}/archive | PUT | 归档 |
| /api/business | GET | 多条件查询筛选 |
### 3. 数据统计分析
| 接口 | 方法 | 说明 |
|------|------|------|
| /api/statistics/summary | GET | 数据汇总 |
| /api/statistics/chart | GET | 图表数据 |
| /api/statistics/custom-query | POST | 自定义查询 |
| /api/statistics/export | GET | 报表导出 |
| /api/statistics/ledger | GET | 台账生成 |
### 4. 日志审计管理
| 接口 | 方法 | 说明 |
|------|------|------|
| /api/log/login | POST | 记录登录日志 |
| /api/log/operation | POST | 记录操作日志 |
| /api/log/exception | POST | 记录异常日志 |
| /api/log | GET | 多条件日志查询 |
### 5. 系统对接集成
| 接口 | 方法 | 说明 |
|------|------|------|
| /api/integration/api-definitions | GET | 获取标准化接口定义 |
| /api/integration/import | POST | 第三方数据导入 |
| /api/integration/push | POST | 数据推送 |
| /api/integration/sync | POST | 数据同步 |
### 6. 字典与参数配置
| 接口 | 方法 | 说明 |
|------|------|------|
| /api/dict | POST | 新增字典项 |
| /api/dict/{id} | PUT | 编辑字典项 |
| /api/dict/{id} | DELETE | 删除字典项 |
| /api/dict | GET | 查询字典列表 |
| /api/config | POST | 新增参数配置 |
| /api/config/{id} | PUT | 编辑参数配置 |
| /api/config/{id} | DELETE | 删除参数配置 |
| /api/config | GET | 查询参数配置列表 |
### 7. 健康检查
| 接口 | 方法 | 说明 |
|------|------|------|
| /api/health | GET | 系统健康检查 |