Commit Graph

15 Commits

Author SHA1 Message Date
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