docs: 文档修改优化
This commit is contained in:
1 parent
7cd5b4fb66
commit
609698be81
5 files changed
+178
-97
No files matched your search
@@ -19,30 +19,6 @@ license-manager/
|
||||
└── bin/ # 编译产物目录
|
||||
```
|
||||
|
||||
## 后端目录 (backend/)
|
||||
|
||||
```
|
||||
backend/
|
||||
├── cmd/ # 应用程序入口
|
||||
│ └── main.go # 主程序入口文件
|
||||
├── internal/ # 内部包(不对外暴露)
|
||||
│ ├── api/ # API路由和控制器
|
||||
│ ├── config/ # 配置管理
|
||||
│ ├── models/ # 数据模型定义
|
||||
│ ├── service/ # 业务逻辑层
|
||||
│ ├── repository/ # 数据访问层
|
||||
│ └── middleware/ # HTTP中间件
|
||||
├── pkg/ # 可重用的公共包
|
||||
├── configs/ # 配置文件目录
|
||||
│ ├── config.yaml # 生产环境配置
|
||||
│ └── config.example.yaml # 配置模板文件
|
||||
├── migrations/ # 数据库迁移脚本
|
||||
├── scripts/ # 后端专用脚本
|
||||
├── tools/ # 硬件信息获取工具
|
||||
├── go.mod # Go模块依赖
|
||||
└── go.sum # Go依赖校验
|
||||
```
|
||||
|
||||
## 前端目录 (frontend/)
|
||||
|
||||
```
|
||||
|
||||
@@ -119,47 +119,8 @@
|
||||
- 客户管理、授权生成、授权列表和详情页面
|
||||
- 系统仪表盘、用户登录页面
|
||||
|
||||
### 6.2 RESTful API接口
|
||||
- `POST /api/validate` - 授权验证
|
||||
- `POST /api/activate` - 授权激活
|
||||
- `POST /api/heartbeat` - 心跳上报
|
||||
- `GET /api/license/{code}` - 授权信息查询
|
||||
- `GET /api/customers` - 客户列表API
|
||||
- `GET /tools/{tool}` - 工具下载
|
||||
|
||||
### 6.3 数据格式
|
||||
- 统一JSON格式数据交换
|
||||
- 统一错误响应格式
|
||||
- 支持数据分页和筛选
|
||||
|
||||
## 7. 项目交付物
|
||||
|
||||
### 7.1 软件交付
|
||||
- 完整源代码(前后端)
|
||||
- 编译后的可执行文件
|
||||
- Docker镜像文件
|
||||
- 数据库初始化脚本
|
||||
|
||||
### 7.2 文档交付
|
||||
- 部署安装文档
|
||||
- API接口文档
|
||||
- 用户操作手册
|
||||
- 系统架构文档
|
||||
|
||||
### 7.3 工具交付
|
||||
- 硬件信息获取工具(Windows/Linux)
|
||||
- 客户端SDK示例
|
||||
- 配置文件模板
|
||||
|
||||
## 8. 开发计划
|
||||
|
||||
### 8.1 开发阶段
|
||||
1. **架构设计**(1周):技术选型、数据库设计、API设计
|
||||
2. **核心功能**(3周):客户管理、授权生成、验证API
|
||||
3. **Web界面**(2周):前端页面开发、交互逻辑
|
||||
4. **测试部署**(1周):功能测试、性能测试、部署验证
|
||||
|
||||
### 8.2 质量保证
|
||||
- 单元测试覆盖率 > 80%
|
||||
- 接口测试和性能测试
|
||||
- 安全性测试和代码审查
|
||||
Reference in new issue
Block a user