83 lines
1.2 KiB
Markdown
83 lines
1.2 KiB
Markdown
# {{MODULE_NAME}}模块设计说明
|
||
|
||
## 一、功能概述
|
||
|
||
### 1.1 模块简介
|
||
{{MODULE_DESCRIPTION}}
|
||
|
||
### 1.2 主要功能
|
||
- 功能点1:描述
|
||
- 功能点2:描述
|
||
- 功能点3:描述
|
||
|
||
## 二、需求分析
|
||
|
||
### 2.1 功能性需求
|
||
{{FUNCTIONAL_REQUIREMENTS}}
|
||
|
||
### 2.2 非功能性需求
|
||
{{NON_FUNCTIONAL_REQUIREMENTS}}
|
||
|
||
## 三、技术架构
|
||
|
||
### 3.1 技术选型
|
||
- 后端框架:RuoYi-Vue-Pro
|
||
- 前端框架:yudao-ui-admin-vue3
|
||
- 数据库:MySQL 8.0+
|
||
- 缓存:Redis
|
||
|
||
### 3.2 架构图
|
||
|
||
## 四、功能模块设计
|
||
|
||
### 4.1 模块结构
|
||
{{MODULE_STRUCTURE}}
|
||
|
||
### 4.2 核心类设计
|
||
{{CLASS_DESIGN}}
|
||
|
||
## 五、数据库设计
|
||
|
||
### 5.1 数据表设计
|
||
{{TABLE_DESIGN}}
|
||
|
||
## 六、接口设计
|
||
|
||
### 6.1 REST API设计
|
||
{{API_DESIGN}}
|
||
|
||
### 6.2 接口列表
|
||
{{API_LIST}}
|
||
|
||
## 七、安全设计
|
||
|
||
### 7.1 权限控制
|
||
{{PERMISSION_DESIGN}}
|
||
|
||
### 7.2 数据安全
|
||
{{DATA_SECURITY}}
|
||
|
||
## 八、性能设计
|
||
|
||
### 8.1 性能指标
|
||
{{PERFORMANCE_METRICS}}
|
||
|
||
### 8.2 优化策略
|
||
{{OPTIMIZATION_STRATEGY}}
|
||
|
||
## 九、部署设计
|
||
|
||
### 9.1 部署架构
|
||
{{DEPLOYMENT_ARCHITECTURE}}
|
||
|
||
### 9.2 环境配置
|
||
{{ENVIRONMENT_CONFIG}}
|
||
|
||
## 十、测试方案
|
||
|
||
### 10.1 测试策略
|
||
{{TEST_STRATEGY}}
|
||
|
||
### 10.2 测试用例
|
||
{{TEST_CASES}}
|