From 946d328be658e436d2e22e492c0dade1d16e6a5d Mon Sep 17 00:00:00 2001 From: moyin <244344649@qq.com> Date: Thu, 25 Dec 2025 20:40:45 +0800 Subject: [PATCH] =?UTF-8?q?docs=EF=BC=9A=E6=9B=B4=E6=96=B0=E7=99=BB?= =?UTF-8?q?=E5=BD=95=E9=AA=8C=E8=AF=81=E7=A0=81=E9=82=AE=E4=BB=B6=E6=A8=A1?= =?UTF-8?q?=E6=9D=BF=E4=BF=AE=E5=A4=8D=E7=9B=B8=E5=85=B3=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 在API文档重要提醒中添加邮件模板修复说明 - 更新OpenAPI文档版本号至1.1.3 - 增强发送登录验证码接口的描述，明确说明使用专门的登录验证码模板 --- docs/api/api-documentation.md | 8 ++++++++ docs/api/openapi.yaml | 6 +++--- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/api/api-documentation.md b/docs/api/api-documentation.md index 0c9f184..26171be 100644 --- a/docs/api/api-documentation.md +++ b/docs/api/api-documentation.md @@ -11,6 +11,8 @@ 3. **验证码有效期**: 所有验证码有效期为5分钟 4. **频率限制**: 验证码发送限制1次/分钟，注册限制10次/5分钟 5. **测试模式**: 开发环境下邮件服务返回206状态码，验证码在响应中返回 +6. **冷却时间自动清除**: 注册、密码重置、验证码登录成功后会自动清除验证码冷却时间，方便后续操作 +7. **邮件模板修复**: 登录验证码现在使用正确的邮件模板，内容为"登录验证码"而非"密码重置" ### 错误处理规范 - **409 Conflict**: 资源冲突（用户名、邮箱已存在） @@ -24,6 +26,7 @@ 2. 邮箱注册流程：先发送验证码 → 检查409冲突 → 使用验证码注册 3. 测试模式下验证码在响应中返回，生产环境需用户查收邮件 4. 实现重试机制处理429频率限制错误 +5. 注册/重置密码成功后，验证码冷却时间会自动清除，可立即发送新验证码 --- @@ -945,6 +948,11 @@ ## 📊 版本更新记录 +### v1.1.2 (2025-12-25) +- **验证码冷却优化**: 注册、密码重置、验证码登录成功后自动清除验证码冷却时间 +- **用户体验提升**: 成功操作后可立即发送新的验证码，无需等待冷却时间 +- **代码健壮性**: 冷却时间清除失败不影响主要业务流程 + ### v1.1.1 (2025-12-25) - **邮箱冲突检测优化**: 发送邮箱验证码前检查邮箱是否已被注册 - **用户体验提升**: 避免向已注册邮箱发送无用验证码 diff --git a/docs/api/openapi.yaml b/docs/api/openapi.yaml index 39ddfbb..7a4b7fd 100644 --- a/docs/api/openapi.yaml +++ b/docs/api/openapi.yaml @@ -1,8 +1,8 @@ openapi: 3.0.3 info: title: Pixel Game Server - Auth API - description: 像素游戏服务器用户认证API接口文档 - 包含验证码登录功能和邮箱冲突检测 - version: 1.1.1 + description: 像素游戏服务器用户认证API接口文档 - 包含验证码登录功能、邮箱冲突检测、验证码冷却优化和邮件模板修复 + version: 1.1.3 contact: name: API Support email: support@example.com @@ -489,7 +489,7 @@ paths: tags: - auth summary: 发送登录验证码 - description: 向用户邮箱或手机发送登录验证码 + description: 向用户邮箱或手机发送登录验证码。邮件内容使用专门的登录验证码模板，标题为"登录验证码"，内容说明用于登录验证而非密码重置。 operationId: sendLoginVerificationCode requestBody: required: true