Browse Source

docs: 更新 README.md,添加角色管理模块说明

web
hyh 3 months ago
parent
commit
423f5335be
  1. 50
      README.md

50
README.md

@ -123,6 +123,56 @@ CellularManagement/
- 消息吞吐量
- 延迟监控
## 角色管理模块
角色管理模块提供了完整的角色 CRUD 操作,采用 CQRS 模式实现,将命令和查询职责分离。
### 功能特性
- 创建角色
- 删除角色
- 获取单个角色
- 获取所有角色
### API 端点
| 方法 | 端点 | 描述 |
|--------|-------------------|--------------|
| POST | /api/roles/create | 创建新角色 |
| DELETE | /api/roles/{id} | 删除角色 |
| GET | /api/roles/{id} | 获取单个角色 |
| GET | /api/roles | 获取所有角色 |
### 代码结构
```
Features/Roles/
├── Commands/
│ ├── CreateRole/
│ │ ├── CreateRoleCommand.cs
│ │ ├── CreateRoleCommandHandler.cs
│ │ └── CreateRoleResponse.cs
│ ├── DeleteRole/
│ │ ├── DeleteRoleCommand.cs
│ │ ├── DeleteRoleCommandHandler.cs
│ │ └── DeleteRoleResponse.cs
│ └── RoleCommandHandler.cs
└── Queries/
├── GetRole/
│ ├── GetRoleQuery.cs
│ └── GetRoleResponse.cs
├── GetAllRolesQuery.cs
└── RoleQueryHandler.cs
```
### 设计模式
- CQRS(命令查询职责分离)
- 单一职责原则
- 依赖注入
- 异常处理
- 日志记录
## 开发环境要求
- .NET 8.0 SDK
- 最新的 .NET 开发工具

Loading…
Cancel
Save