forked from datawhale/whale-town-end
* 新增完整的 API 状态码文档,并对测试模式进行特殊处理(`206 Partial Content`) * 重组 DTO 结构,引入 `app.dto.ts` 与 `error_response.dto.ts`,以实现统一、规范的响应格式 * 重构登录相关 DTO,优化命名与结构,提升可维护性 * 实现基于内存的用户服务(`users_memory.service.ts`),用于开发与测试环境 * 更新邮件服务,增强验证码生成逻辑,并支持测试模式自动识别 * 增强登录控制器与服务层的错误处理能力,统一响应行为 * 优化核心登录服务,强化参数校验并集成邮箱验证流程 * 新增 `@types/express` 依赖,提升 TypeScript 类型支持与开发体验 * 改进 `main.ts`,优化应用初始化流程与配置管理 * 在所有服务中统一错误处理机制,采用标准化的错误响应格式 * 实现测试模式(`206`)与生产环境邮件发送(`200`)之间的无缝切换
84 lines
2.7 KiB
TypeScript
84 lines
2.7 KiB
TypeScript
import { NestFactory } from '@nestjs/core';
|
||
import { AppModule } from './app.module';
|
||
import { ValidationPipe } from '@nestjs/common';
|
||
import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
|
||
|
||
/**
|
||
* 检查数据库配置是否完整 by angjustinl 2025-12-17
|
||
*
|
||
* @returns 是否配置了数据库
|
||
*/
|
||
function isDatabaseConfigured(): boolean {
|
||
const requiredEnvVars = ['DB_HOST', 'DB_PORT', 'DB_USERNAME', 'DB_PASSWORD', 'DB_NAME'];
|
||
return requiredEnvVars.every(varName => process.env[varName]);
|
||
}
|
||
|
||
/**
|
||
* 打印启动横幅
|
||
*/
|
||
function printBanner() {
|
||
const isDatabaseMode = isDatabaseConfigured();
|
||
|
||
console.log('\n' + '='.repeat(70));
|
||
console.log('🎮 Pixel Game Server');
|
||
console.log('='.repeat(70));
|
||
console.log(`📦 存储模式: ${isDatabaseMode ? '数据库模式 (MySQL)' : '内存模式 (Memory)'}`);
|
||
|
||
if (!isDatabaseMode) {
|
||
console.log('⚠️ 警告: 未检测到数据库配置,使用内存存储');
|
||
console.log('💡 提示: 数据将在服务重启后丢失');
|
||
console.log('📝 配置: 请在 .env 文件中配置数据库连接信息');
|
||
} else {
|
||
console.log('✅ 数据库: 已连接到 MySQL 数据库');
|
||
}
|
||
|
||
console.log('='.repeat(70) + '\n');
|
||
}
|
||
|
||
async function bootstrap() {
|
||
const app = await NestFactory.create(AppModule, {
|
||
logger: ['error', 'warn', 'log'],
|
||
});
|
||
|
||
// 全局启用校验管道(核心配置)
|
||
app.useGlobalPipes(
|
||
new ValidationPipe({
|
||
whitelist: true, // 过滤掉 DTO 中未定义的字段(比如传了个 `age` 但 DTO 里没有,会自动忽略)
|
||
forbidNonWhitelisted: true, // 若传了未定义的字段,直接报错(防止传多余参数)
|
||
transform: true, // 自动把入参转为 DTO 对应的类型(比如前端传的字符串数字 `'1'` 转为数字 `1`)
|
||
}),
|
||
);
|
||
|
||
// 配置Swagger文档
|
||
const config = new DocumentBuilder()
|
||
.setTitle('Pixel Game Server API')
|
||
.setDescription('像素游戏服务器API文档 - 包含用户认证、登录注册等功能')
|
||
.setVersion('1.0.0')
|
||
.addTag('auth', '用户认证相关接口')
|
||
.addBearerAuth(
|
||
{
|
||
type: 'http',
|
||
scheme: 'bearer',
|
||
bearerFormat: 'JWT',
|
||
name: 'JWT',
|
||
description: '请输入JWT token',
|
||
in: 'header',
|
||
},
|
||
'JWT-auth',
|
||
)
|
||
.build();
|
||
|
||
const document = SwaggerModule.createDocument(app, config);
|
||
SwaggerModule.setup('api-docs', app, document, {
|
||
swaggerOptions: {
|
||
persistAuthorization: true,
|
||
},
|
||
});
|
||
|
||
await app.listen(3000);
|
||
console.log('Pixel Game Server is running on http://localhost:3000');
|
||
console.log('API Documentation is available at http://localhost:3000/api-docs');
|
||
}
|
||
|
||
bootstrap();
|