docs: 更新项目文档和API接口说明

更新CHANGELOG.md记录1.2.0版本变更
完善README.md项目说明和技术栈信息
重构DEPLOYMENT.md部署指南
详细编写API接口文档
This commit is contained in:
zhang1106
2026-02-05 13:59:28 +08:00
parent 39bea07d42
commit 719812f012
4 changed files with 1408 additions and 318 deletions
+115 -2
View File
@@ -2,6 +2,59 @@
所有版本变更记录按时间倒序排列。
---
## [1.2.0] - 2026-02-05
### 新增功能
#### 端口与线缆管理
- 新增设备端口管理模块,支持端口类型、速率、状态配置
- 新增网卡管理功能,支持网卡与端口绑定
- 新增线缆管理模块,支持机柜间线缆连接追踪
- 端口面板可视化展示
#### 系统功能增强
- 新增系统设置管理,支持站点名称、Logo等配置
- 新增背景配置管理,支持自定义系统背景
- 完善用户权限管理,支持角色权限分配
### 优化
#### 3D可视化性能优化
- 优化 Scene.jsx 渲染配置,降低设备像素比至 [1, 1.2]
- 减小阴影贴图尺寸至 [1024, 1024]
- 移除 ContactShadows 组件以减少阴影计算
- 简化光源配置,移除冗余 pointLight
- 优化环境光分辨率配置
#### 设备模型优化
- 实现性能模式(PERFORMANCE_MODE)以简化设备细节
- 添加设备滑轨动画控制开关
- 设备弹出动画默认关闭,可通过界面开关启用
- 优化设备状态指示灯渲染性能
#### LOD(多级细节)系统
- 实现 LOD 管理器,根据相机距离自动切换设备细节级别
- 高细节模式:完整设备模型,包含所有端口和细节
- 中等细节模式:简化设备模型,使用 InstancedMesh 渲染端口
- 低细节模式:极简设备模型,仅保留基本轮廓和状态灯
- 修复 LOD 切换时设备位置偏移问题
#### 交互体验改进
- 添加设备弹出动画开关控制
- 优化设备悬停和点击交互响应
- 改进视角控制流畅度
### 修复
- 修复 AnimationManager 导入错误,移除对不存在文件的引用
- 修复设备在缩放时位置偏移的问题
- 修复 LOD 模型中状态灯位置计算错误
- 修复 LODManager 中的几何体参数错误
---
## [1.1.0] - 2026-01-26
### 优化
@@ -94,13 +147,19 @@
- Three.js 0.160.0
- React Router 6.15.0
- Axios 1.5.0
- Day.js 1.11.19
- SheetJS (xlsx) 0.18.5
- PapaParse 5.5.3
#### 后端技术栈
- Node.js ≥14.0.0
- Express 4.18.2
- Sequelize 6.32.1
- SQLite/MySQL 支持
- CORS 跨域配置
- JWT 9.0.3
- bcryptjs 3.0.3
- Winston 3.19.0
- Jest 30.2.0
### 数据库模型
@@ -108,6 +167,9 @@
- Rack(机柜)
- Device(设备)
- DeviceField(设备字段)
- DevicePort(设备端口)
- NetworkCard(网卡)
- Cable(线缆)
- Ticket(工单)
- TicketField(工单字段)
- TicketCategory(工单分类)
@@ -157,18 +219,60 @@
- 更新设备字段:`PUT /api/deviceFields/:id`
- 删除设备字段:`DELETE /api/deviceFields/:id`
#### 设备端口接口
- 获取端口列表:`GET /api/device-ports`
- 创建端口:`POST /api/device-ports`
- 更新端口:`PUT /api/device-ports/:id`
- 删除端口:`DELETE /api/device-ports/:id`
#### 网卡接口
- 获取网卡列表:`GET /api/network-cards`
- 创建网卡:`POST /api/network-cards`
- 更新网卡:`PUT /api/network-cards/:id`
- 删除网卡:`DELETE /api/network-cards/:id`
#### 线缆接口
- 获取线缆列表:`GET /api/cables`
- 创建线缆:`POST /api/cables`
- 更新线缆:`PUT /api/cables/:id`
- 删除线缆:`DELETE /api/cables/:id`
#### 工单接口
- 获取工单列表:`GET /api/tickets`
- 创建工单:`POST /api/tickets`
- 更新工单:`PUT /api/tickets/:ticketId`
- 删除工单:`DELETE /api/tickets/:ticketId`
#### 工单分类接口
- 获取分类列表:`GET /api/ticket-categories`
- 创建分类:`POST /api/ticket-categories`
- 更新分类:`PUT /api/ticket-categories/:id`
- 删除分类:`DELETE /api/ticket-categories/:id`
#### 工单字段接口
- 获取字段列表:`GET /api/ticket-fields`
- 创建字段:`POST /api/ticket-fields`
- 更新字段:`PUT /api/ticket-fields/:id`
- 删除字段:`DELETE /api/ticket-fields/:id`
#### 耗材接口
- 获取耗材列表:`GET /api/consumables`
- 创建耗材:`POST /api/consumables`
- 更新耗材:`PUT /api/consumables/:consumableId`
- 删除耗材:`DELETE /api/consumables/:consumableId`
#### 耗材分类接口
- 获取分类列表:`GET /api/consumable-categories`
- 创建分类:`POST /api/consumable-categories`
- 更新分类:`PUT /api/consumable-categories/:id`
- 删除分类:`DELETE /api/consumable-categories/:id`
#### 耗材记录接口
- 获取记录列表:`GET /api/consumable-records`
- 创建记录:`POST /api/consumable-records`
- 更新记录:`PUT /api/consumable-records/:id`
- 删除记录:`DELETE /api/consumable-records/:id`
#### 用户接口
- 获取用户列表:`GET /api/users`
- 创建用户:`POST /api/users`
@@ -181,6 +285,14 @@
- 更新角色:`PUT /api/roles/:roleId`
- 删除角色:`DELETE /api/roles/:roleId`
#### 系统设置接口
- 获取系统设置:`GET /api/system-settings`
- 更新系统设置:`PUT /api/system-settings`
#### 背景配置接口
- 获取背景配置:`GET /api/background`
- 更新背景配置:`PUT /api/background`
---
## 格式说明
@@ -191,7 +303,8 @@
- **优化**:功能改进和性能优化
- **修复**bug修复
- **废弃**:即将移除的功能
- ** Breaking Change**:破坏性变更
- **移除**:已移除的功能
- **安全**:安全相关的修复
## 版本号规范