From 9f606abbb2f010d45e5b38deb2ef59d18d4ac75f Mon Sep 17 00:00:00 2001 From: moyin <244344649@qq.com> Date: Thu, 25 Dec 2025 16:15:52 +0800 Subject: [PATCH] =?UTF-8?q?chore:=20=E5=8D=87=E7=BA=A7=E7=89=88=E6=9C=AC?= =?UTF-8?q?=E5=88=B01.1.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 版本升级：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更新日志 --- docs/api/api-documentation.md | 13 +++++++++++++ docs/api/openapi.yaml | 4 ++-- package.json | 4 ++-- src/app.service.ts | 2 +- src/main.ts | 4 ++-- 5 files changed, 20 insertions(+), 7 deletions(-) diff --git a/docs/api/api-documentation.md b/docs/api/api-documentation.md index 457b3d2..26c7ec1 100644 --- a/docs/api/api-documentation.md +++ b/docs/api/api-documentation.md @@ -2288,6 +2288,19 @@ echo "📈 性能测试完成，请查看上述结果" 这些测试场景和边界条件将帮助前端开发者进行全面的API测试，确保应用的稳定性和安全性。 +- **v1.1.0** (2025-12-25): + - **新增验证码登录功能** + - 添加验证码登录接口 (POST /auth/verification-code-login) + - 添加发送登录验证码接口 (POST /auth/send-login-verification-code) + - 支持邮箱和手机号验证码登录 + - 完善验证码相关错误处理和限流机制 + - **文档完善** + - 更新API文档，新增验证码登录相关说明 + - 修正错误码与实际响应的一致性 + - 添加验证码登录测试场景和使用示例 + - 更新OpenAPI规范文档 + - **接口数量更新**：21个 → 23个API接口 + - **用户认证接口**：11个 → 13个接口 - **v1.0.0** (2025-12-24): - **完整的API文档更新** - 重新整理接口分类，将用户管理接口独立分类 diff --git a/docs/api/openapi.yaml b/docs/api/openapi.yaml index e4774d3..3235acc 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.0.0 + description: 像素游戏服务器用户认证API接口文档 - 包含验证码登录功能 + version: 1.1.0 contact: name: API Support email: support@example.com diff --git a/package.json b/package.json index 9c60e3a..1e8e2ab 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "pixel-game-server", - "version": "1.0.0", - "description": "A 2D pixel art game server built with NestJS", + "version": "1.1.0", + "description": "A 2D pixel art game server built with NestJS - 支持验证码登录功能", "main": "dist/main.js", "scripts": { "dev": "nest start --watch", diff --git a/src/app.service.ts b/src/app.service.ts index ef9dea5..7b1ca9a 100644 --- a/src/app.service.ts +++ b/src/app.service.ts @@ -31,7 +31,7 @@ export class AppService { return { service: 'Pixel Game Server', - version: '1.0.0', + version: '1.1.0', status: 'running', timestamp: new Date().toISOString(), uptime: Math.floor((Date.now() - this.startTime) / 1000), diff --git a/src/main.ts b/src/main.ts index a917c46..ccdb0a0 100644 --- a/src/main.ts +++ b/src/main.ts @@ -58,8 +58,8 @@ async function bootstrap() { // 配置Swagger文档 const config = new DocumentBuilder() .setTitle('Pixel Game Server API') - .setDescription('像素游戏服务器API文档 - 包含用户认证、登录注册等功能') - .setVersion('1.0.0') + .setDescription('像素游戏服务器API文档 - 包含用户认证、登录注册、验证码登录等功能') + .setVersion('1.1.0') .addTag('auth', '用户认证相关接口') .addTag('admin', '管理员后台相关接口') .addBearerAuth(