datawhale/whale-town-end
3
4
Fork 2
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
116 Commits 4 Branches 0 Tags
946d328be658e436d2e22e492c0dade1d16e6a5d
Commit Graph

25 Commits

Author SHA1 Message Date
moyin
946d328be6 docs：更新登录验证码邮件模板修复相关文档 
- 在API文档重要提醒中添加邮件模板修复说明
- 更新OpenAPI文档版本号至1.1.3
- 增强发送登录验证码接口的描述，明确说明使用专门的登录验证码模板
 2025-12-25 20:40:45 +08:00
moyin
d683f0d5da feat: 邮箱冲突检测优化 v1.1.1 
- 新增邮箱冲突检测：发送验证码前检查邮箱是否已被注册
- 优化用户体验：避免向已注册邮箱发送无用验证码
- 改进错误处理：返回409 Conflict状态码和明确错误信息
- 更新API文档：重新整理文档结构，突出前端开发要点
- 完善测试用例：添加邮箱冲突检测相关测试
- 版本升级：1.1.0  1.1.1

核心修改：
- src/core/login_core/login_core.service.ts: 在sendEmailVerification方法中添加邮箱存在性检查
- src/business/auth/controllers/login.controller.ts: 正确处理409冲突状态码
- docs/api/api-documentation.md: 重新整理为精简实用的前端开发文档
- docs/api/openapi.yaml: 更新版本和接口描述
- test-register-fix.ps1: 添加邮箱冲突检测测试用例
 2025-12-25 18:31:36 +08:00
moyin
aae77866ac docs: 更新API文档，反映HTTP状态码修复 
文档更新内容：
- 更新注册接口响应示例，区分400和409状态码
- 添加资源冲突响应示例（用户名、邮箱、手机号已存在）
- 完善OpenAPI文档，添加详细的响应示例
- 更新错误码表格，明确不同错误的状态码
- 添加HTTP状态码测试场景

 修复说明：
- 409 Conflict：用户名/邮箱/手机号已存在
- 400 Bad Request：验证码错误/参数格式错误
- 符合RESTful API规范

 测试验证：
- 邮箱冲突：HTTP 409
- 用户名冲突：HTTP 409
- 验证码错误：HTTP 400

 前端开发者现在可以：
- 根据HTTP状态码进行精确的错误处理
- 移除临时解决方案，使用标准状态码判断
- 提供更好的用户体验和错误提示
 2025-12-25 16:32:51 +08:00
moyin
9f606abbb2 chore: 升级版本到1.1.0 
版本升级：1.0.0  1.1.0

 新功能：
- 验证码登录功能完整实现
- 支持邮箱和手机号验证码登录
- 新增2个API接口（总计23个）

 文档更新：
- Swagger API文档版本更新
- OpenAPI规范文档更新
- 手动API文档版本更新
- 添加v1.1.0版本更新日志

 技术改进：
- 完善验证码相关错误处理
- 优化API响应格式一致性
- 增强测试覆盖率

 更新内容：
- package.json: 1.0.0  1.1.0
- Swagger配置: 1.0.0  1.1.0
- OpenAPI文档: 1.0.0  1.1.0
- 应用状态接口: 1.0.0  1.1.0
- API文档: 添加v1.1.0更新日志
 2025-12-25 16:15:52 +08:00
moyin
7385c63ffd feat(docs): 更新OpenAPI文档，添加验证码登录和完整接口定义 
- 添加验证码登录接口：/auth/verification-code-login
- 添加发送登录验证码接口：/auth/send-login-verification-code
- 添加邮箱验证相关接口：send/verify/resend-email-verification
- 添加调试接口：debug-verification-code, debug-clear-throttle
- 添加应用状态接口：GET /
- 完善所有Schema定义和响应格式
- 添加测试模式和限流错误响应
- 确保OpenAPI文档与实际API完全匹配
 2025-12-25 16:11:07 +08:00
moyin
d59e9531e2 fix(docs): 修正API文档中的错误码和验证码说明 
- 修正验证码登录错误码：VERIFICATION_CODE_INVALID -> VERIFICATION_CODE_LOGIN_FAILED
- 修正发送登录验证码错误码：USER_NOT_FOUND -> SEND_LOGIN_CODE_FAILED
- 添加验证码登录相关错误码到错误码表格
- 完善验证码使用说明和注意事项
- 确保文档与实际API响应完全一致
 2025-12-25 16:04:34 +08:00
moyin
68debdcb40 docs: 完善API文档，添加验证码登录功能说明 
- 新增验证码登录接口文档 (POST /auth/verification-code-login)
- 新增发送登录验证码接口文档 (POST /auth/send-login-verification-code)
- 更新接口列表和数量统计 (21个 -> 23个接口)
- 添加验证码登录测试场景和cURL示例
- 完善错误码说明和响应格式
- 确保文档与当前实现完全一致
 2025-12-25 15:44:37 +08:00
moyin
404ef5d3e0 fix：修复注册逻辑和HTTP状态码问题 
核心修复：
- 调整注册流程检查顺序，先验证用户存在性再验证验证码
- 修复HTTP状态码问题，业务失败时返回正确的错误状态码
- 优化错误处理逻辑，提供更准确的错误信息

主要变更：
- 登录核心服务：重构注册方法，优化检查顺序避免验证码无效消费
- 用户服务：分离用户创建和重复检查逻辑，提高代码复用性
- 登录控制器：修复HTTP状态码处理，根据业务结果返回正确状态码
- API文档：更新注册接口说明和错误响应示例
- 测试脚本：优化测试逻辑和注释说明

修复效果：
- 用户已存在时立即返回正确错误信息，不消费验证码
- API响应状态码准确反映业务执行结果
- 错误信息更加用户友好和准确
- 验证码使用更加合理和高效

测试验证：
- 所有核心功能测试通过
- 注册逻辑修复验证成功
- HTTP状态码修复验证成功
- 限流功能正常工作
 2025-12-24 20:39:23 +08:00
moyin
cb25703892 fix：修复API状态码和限流配置问题 
- 修复登录控制器HTTP状态码问题，现在根据业务结果返回正确状态码
- 调整注册接口限流配置，从3次/5分钟放宽至10次/5分钟（开发环境）
- 新增清除限流记录的调试接口，便于开发测试
- 更新API文档，反映状态码修复和限流调整
- 添加测试脚本验证修复效果

主要修复：
- 业务失败时返回400/401而非200/201状态码
- 注册、登录、GitHub OAuth等接口现在正确处理错误状态码
- 限流配置更适合开发环境测试需求
 2025-12-24 19:41:21 +08:00
moyin
85d488a508 docs: 重构文档结构和组织 
- 重新组织docs目录结构，按功能模块分类
- 新增deployment和development目录
- 更新API文档结构
- 添加客户端README文档
- 移除过时的文档文件
 2025-12-24 18:04:14 +08:00
moyin
032c97a1fc docs: 全面更新API接口文档 
- 重构文档结构，按功能模块分类
- 新增应用状态接口 (GET /)
- 完善用户认证接口，新增4个邮箱验证相关接口
- 新增管理员后台接口，包含用户管理和日志管理
- 更新错误代码说明和数据验证规则
- 完善使用示例和注意事项
- 更新版本日志至v1.0.0

涵盖后端所有API接口，提供完整的开发参考文档
 2025-12-23 19:51:34 +08:00
jianuo
a4a3a60db7 feat：添加日志功能 2025-12-19 20:01:45 +08:00
jianuo
dd4fb6edd3 feat：简单添加管理员后台功能 2025-12-19 19:17:47 +08:00
moyin
7924cfb201 docs：重构README和贡献者文档，完善项目架构说明和测试指南 
- 重构README结构，按新开发者学习流程组织内容
- 更新项目架构图和技术栈说明，基于实际代码结构
- 创建CONTRIBUTORS.md，记录所有贡献者信息和统计
- 添加TESTING.md测试指南，支持无依赖快速测试
- 创建docs/ARCHITECTURE.md详细架构设计文档
- 优化.env.example配置，支持测试和生产环境切换
- 添加跨平台测试脚本(test-api.ps1/test-api.sh)
- 删除冗余测试文件，统一测试入口
- 更新所有链接为正确的Gitea仓库地址
- 添加MIT开源协议文件
 2025-12-18 15:03:09 +08:00
angjustinl
26ea5ac815 feat(sql, auth, email, dto)：重构邮箱验证流程，引入基于内存的用户服务，并改进 API 响应处理 
* 新增完整的 API 状态码文档，并对测试模式进行特殊处理（`206 Partial Content`）
* 重组 DTO 结构，引入 `app.dto.ts` 与 `error_response.dto.ts`，以实现统一、规范的响应格式
* 重构登录相关 DTO，优化命名与结构，提升可维护性
* 实现基于内存的用户服务（`users_memory.service.ts`），用于开发与测试环境
* 更新邮件服务，增强验证码生成逻辑，并支持测试模式自动识别
* 增强登录控制器与服务层的错误处理能力，统一响应行为
* 优化核心登录服务，强化参数校验并集成邮箱验证流程
* 新增 `@types/express` 依赖，提升 TypeScript 类型支持与开发体验
* 改进 `main.ts`，优化应用初始化流程与配置管理
* 在所有服务中统一错误处理机制，采用标准化的错误响应格式
* 实现测试模式（`206`）与生产环境邮件发送（`200`）之间的无缝切换
 2025-12-18 00:17:43 +08:00
moyin
e58cc57769 docs：重新组织系统文档结构 
- 将日志系统文档移动到 docs/systems/logger/detailed-specification.md
- 将邮箱验证部署指南移动到 docs/systems/email-verification/deployment-guide.md
- 创建邮箱验证系统完整文档 docs/systems/email-verification/README.md
- 按功能模块组织文档，提高可维护性
 2025-12-17 20:20:00 +08:00
moyin
08bf2bbaf3 docs：更新项目文档结构和说明 
- 重新组织docs目录结构
- 在README中添加API文档系统介绍
- 提供Swagger UI快速访问指南
- 完善文档导航和使用说明
 2025-12-17 15:16:54 +08:00
moyin
1e47c4db60 docs：创建完整的API接口文档 
- 创建详细的API接口说明文档
- 提供OpenAPI 3.0规范文件
- 创建Postman测试集合
- 添加API文档使用指南
 2025-12-17 15:16:27 +08:00
moyin
c14a49a88e chore：更新项目配置 
- 更新pnpm工作区配置
- 完善后端开发规范文档
 2025-12-17 14:40:00 +08:00
moyin
eb2ff99b09 docs：重构文档结构 
- 创建模块化文档系统
- 添加用户认证系统详细文档
- 添加日志系统专门文档
- 简化主README，通过链接引用子系统文档
- 提高文档的可维护性和可读性
 2025-12-17 14:39:55 +08:00
moyin
f980e40fb0 docs：新增日志系统详细使用说明 
- 提供完整的日志文件结构和格式说明
- 包含开发和生产环境的配置差异
- 添加问题排查和日志分析指南
- 提供实用的使用示例和最佳实践
- 说明定时任务和健康监控功能
 2025-12-13 16:44:28 +08:00
moyin
398fbc42bc docs：新增 AI 辅助开发规范指南并更新文档 
新增功能：
- 创建完整的 AI 辅助开发工作流程指南
- 提供实用的提示词模板和检查清单
- 包含详细的实战案例和最佳实践

文档更新：
- 在 README 中强调 AI 指南的重要性
- 添加醒目的必读警告和使用建议
- 重新组织开发文档结构

本次更新旨在帮助开发者使用 AI 工具遵循项目规范，
显著提高开发效率和代码质量。
 2025-12-13 16:30:59 +08:00
moyin
dff0ac8325 docs：重构后端开发指南中的日志部分 
- 将日志记录规范重构为日志系统使用指南
- 保留实用的使用方法和最佳实践
- 添加依赖注入和请求上下文绑定示例
- 简化内容，专注于实际使用方法
 2025-12-13 16:18:33 +08:00
moyin
5dc97532c6 chore：切换包管理器为pnpm（替换yarn） 2025-12-08 17:21:34 +08:00
moyin
e973da4efe docs：创建必要的文档内容，丰富readme 2025-12-08 17:08:43 +08:00