### 如何在 Nest.js 中使用 @nestjs/typeorm 并配置 HTTP 请求的接口文档 #### 安装依赖 为了实现 `@nestjs/typeorm` 的功能并生成实体类，首先需要安装必要的依赖项。可以通过以下命令完成安装： ```bash pnpm add @nestjs/typeorm typeorm mysql2 reflect-metadata ``` 确保已启用 TypeScript 编译选项中的 `emitDecoratorMetadata` 和 `experimentalDecorators`[^2]。 #### 数据库连接配置 在项目的根目录下创建一个 `ormconfig.json` 文件来定义数据库连接参数。以下是 MySQL 数据库的一个示例配置： ```json { "type": "mysql", "host": "localhost", "port": 3306, "username": "root", "password": "password", "database": "test_db", "entities": ["dist/**/*.entity{.ts,.js}"], "synchronize": true } ``` `synchronize: true` 表示每次启动应用时会自动同步实体结构到数据库表中，仅用于开发环境，在生产环境中应禁用此设置[^3]。 #### 实体生成 如果已有现成的数据库表，则可以利用 TypeORM CLI 工具来自动生成对应的实体文件。先全局安装 TypeORM CLI： ```bash pnpm install -g typeorm ``` 接着通过以下命令生成实体： ```bash typeorm entity:create entities/User --connection ormconfig.json ``` 这将在指定路径下生成基于现有数据表结构的实体类。 #### 注入存储库模式 在服务层中注入存储库以便操作数据库记录。例如，在 `AppService` 类中引入用户仓库如下所示： ```typescript import { Injectable } from '@nestjs/common'; import { InjectRepository } from '@nestjs/typeorm'; import { Repository } from 'typeorm'; import { User } from '../entities/User.entity'; @Injectable() export class AppService { constructor( @InjectRepository(User) private readonly userRepository: Repository<User>, ) {} findAll(): Promise<User[]> { return this.userRepository.find(); } } ``` 上述方法实现了查询所有用户的逻辑。 #### 配置 Swagger 文档支持 对于 API 接口文档的支持，推荐集成 Swagger 模块。首先需安装相关包： ```bash pnpm add @nestjs/swagger swagger-ui-express ``` 随后修改主模块 (`app.module.ts`) 添加 Swagger 功能： ```typescript import { Module } from '@nestjs/common'; import { APP_FILTER, APP_INTERCEPTOR } from '@nestjs/core'; import { HttpExceptionFilter } from './filters/http-exception.filter'; import { LoggingInterceptor } from './interceptors/logging.interceptor'; import { AppController } from './app.controller'; import { AppService } from './app.service'; import { UsersModule } from './users/users.module'; import { TypeOrmModule } from '@nestjs/typeorm'; import { User } from './entities/User.entity'; import { ConfigModule } from '@nestjs/config'; import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'; @Module({ imports: [ ConfigModule.forRoot(), TypeOrmModule.forRoot(), // 加载 ORM 配置 UsersModule, TypeOrmModule.forFeature([User]), ], controllers: [AppController], providers: [ AppService, { provide: APP_FILTER, useClass: HttpExceptionFilter }, { provide: APP_INTERCEPTOR, useClass: LoggingInterceptor }, ], }) export class AppModule { configure(consumer: MiddlewareConsumer) {} } // 在 main.ts 或其他初始化位置注册 Swagger UI const config = new DocumentBuilder() .setTitle('NestJS with TypeORM Example') .setDescription('API documentation for the application.') .setVersion('1.0') .build(); const document = SwaggerModule.createDocument(app, config); SwaggerModule.setup('api', app, document); ``` 这样访问 `/api` 路径就可以查看完整的 RESTful API 列表及其描述信息[^1]。 ---