Quellcode durchsuchen

📝 docs(architecture): update component architecture documentation

- rename "新组件" section to "现有组件优化" to reflect current development status
- update "通用CRUD服务" description with implementation status and optimization focus
- revise "API文档组件" section to include current status and documentation improvement focus
yourname vor 2 Monaten
Ursprung
Commit
0a05bd82b0
1 geänderte Dateien mit 6 neuen und 14 gelöschten Zeilen
  1. 6 14
      docs/architecture.md

+ 6 - 14
docs/architecture.md

@@ -117,24 +117,16 @@
 
 ## 组件架构
 
-### 新组件
-**通用CRUD服务增强**:
+### 现有组件优化
+**通用CRUD服务**:
 - **责任**: 提供类型安全的通用CRUD操作,支持自定义扩展
-- **集成点**: 与现有API路由和TypeORM实体集成
-- **关键接口**:
-  - `createCrudRoutes()` - 创建标准CRUD路由
-  - `withCustomOperations()` - 添加自定义业务逻辑
-- **依赖关系**:
-  - **现有组件**: TypeORM Repository, Hono Router
-  - **新组件**: 测试工具和验证工具
-- **技术栈**: TypeScript, Hono RPC, Zod验证
+- **现状**: 已实现完整功能,支持关联查询和复杂操作
+- **优化重点**: 增强错误处理、添加测试覆盖、优化性能
 
 **API文档组件**:
 - **责任**: 自动生成和维护OpenAPI文档
-- **集成点**: 集成@hono/zod-openapi到现有路由
-- **关键接口**:
-  - `generateOpenAPISpec()` - 从路由生成OpenAPI规范
-  - `serveSwaggerUI()` - 提供交互式文档界面
+- **现状**: 通过@hono/zod-openapi集成,提供Swagger UI
+- **优化重点**: 完善文档示例、确保文档与代码同步
 
 ### 组件交互
 ```mermaid