Browse Source

📝 docs(architecture): add hono framework selection explanation
- explain reasons for choosing Hono over Express
- highlight advantages including RPC type safety, ecosystem integration, performance benefits, and deployment flexibility

✅ docs(epics): update completed features in multiple epics
- add "密码重置功能" to epic-2
- add "用户个人信息管理API" to epic-3
- add "API文档生成和维护" to epic-5

📝 docs(stories): add new user stories for recent features
- add story-2-6 for password reset functionality
- add story-3-3 for user profile management
- add story-5-4 for API documentation generation

yourname 2 months ago
parent
commit
64a706e63c

+ 9 - 0
docs/architecture.md

@@ -181,6 +181,15 @@ mini/
 
 ### 2.2 后端技术栈
 
+**框架选型说明**: 选用Hono框架而非Express,主要基于以下考虑:
+- **RPC类型安全**: Hono Client提供端到端类型安全的RPC调用,确保前后端API契约一致性
+- **生态集成**: @hono/swagger-ui提供开箱即用的API文档生成和测试界面
+- **性能优势**: Hono专为Edge环境优化,提供更快的启动时间和更低的内存占用
+- **TypeScript支持**: 原生TypeScript支持,提供更好的类型安全性和开发体验
+- **现代API设计**: 支持最新的Web标准,包括WebSocket、Server-Sent Events等
+- **中间件兼容**: 兼容Express中间件生态,便于迁移和扩展
+- **部署灵活性**: 支持多种运行时环境(Node.js, Deno, Bun, Cloudflare Workers等)
+
 ```json
 {
   "dependencies": {

+ 1 - 0
docs/epics/epic-2-认证授权系统.md

@@ -17,6 +17,7 @@
 - ✅ JWT Token生成和验证
 - ✅ 密码加密(bcrypt)
 - ✅ Token刷新机制
+- ✅ 密码重置功能
 
 #### 3. 会话管理
 - ✅ Redis Session存储

+ 1 - 0
docs/epics/epic-3-用户管理模块.md

@@ -10,6 +10,7 @@
 - ✅ 用户信息更新API
 - ✅ 用户删除API
 - ✅ 用户详情查询API
+- ✅ 用户个人信息管理API
 
 #### 2. 数据查询与过滤
 - ✅ 分页功能支持

+ 1 - 0
docs/epics/epic-5-开发部署工具链.md

@@ -38,6 +38,7 @@
 - ✅ 常用脚本整理
 - ✅ 故障排查指南
 - ✅ 性能优化指南
+- ✅ API文档生成和维护
 
 #### 6. 监控和日志
 - ✅ 应用日志配置

+ 18 - 0
docs/stories/epic-2/story-2-6-密码重置功能.md

@@ -0,0 +1,18 @@
+# Story 2.6: 密码重置功能
+
+**作为** 用户
+**我想** 能够重置忘记的密码
+**以便** 重新获得账户访问权限
+
+## 验收标准
+
+- [ ] 实现密码重置请求API(POST /auth/forgot-password)
+- [ ] 实现密码重置确认API(POST /auth/reset-password)
+- [ ] 发送密码重置邮件
+- [ ] 生成安全的重置令牌
+- [ ] 验证重置令牌有效性
+- [ ] 设置令牌过期时间(1小时)
+- [ ] 处理重复重置请求
+- [ ] 提供清晰的操作指引
+- [ ] 记录密码重置操作日志
+- [ ] 确保重置过程安全可靠

+ 18 - 0
docs/stories/epic-3/story-3-3-用户个人信息管理.md

@@ -0,0 +1,18 @@
+# Story 3.3: 用户个人信息管理
+
+**作为** 用户
+**我想** 能够管理我的个人信息
+**以便** 保持账户信息的准确性和最新状态
+
+## 验收标准
+
+- [ ] 实现用户信息查询API(GET /users/profile)
+- [ ] 实现用户信息更新API(PUT /users/profile)
+- [ ] 支持修改基本信息(姓名、头像、联系方式)
+- [ ] 验证更新数据的有效性
+- [ ] 保护敏感信息不被随意修改
+- [ ] 提供头像上传功能
+- [ ] 记录个人信息变更日志
+- [ ] 确保数据更新操作的原子性
+- [ ] 返回更新后的完整用户信息
+- [ ] 处理并发更新冲突

+ 18 - 0
docs/stories/epic-5/story-5-4-API文档生成.md

@@ -0,0 +1,18 @@
+# Story 5.4: API文档生成
+
+**作为** 开发者
+**我想** 自动生成和维护API文档
+**以便** 提供准确、实时的接口文档供前端和第三方使用
+
+## 验收标准
+
+- [ ] 集成Swagger/OpenAPI文档生成
+- [ ] 自动从代码注释生成API文档
+- [ ] 支持在线API测试和调试
+- [ ] 提供完整的请求/响应示例
+- [ ] 包含参数验证规则说明
+- [ ] 支持多版本API文档
+- [ ] 提供身份认证测试功能
+- [ ] 自动更新文档随代码变更
+- [ ] 支持导出文档为多种格式
+- [ ] 确保文档与代码实际行为一致