安装

nest new project-name

目录解释

• dto目录，配合class-validator进行参数验证

• schemas目录，mongodb映射 文档

• interfaces目录，接口

• common目录，通用

  @Schema()
  export class Cat {}
  // 默认对应数据库中的 cats集合
  // 若要自定义集合名称
  @Schema({ connection: 'custom_name' })

配置mongodb数据库

安装相关包

1. 读取配置文件 pnpm add -S @nestjs/config

   • 根目录下创建.env .prod.env文件，添加环境变量

   • app.moudle.ts中使用

     import { ConfigMoudle } from '@nestjs/config'
     @Module({
       imports: [
         ConfigModule.forRoot({
         envFilePath: process.env.NODE_ENV !== 'production'?'.env.production' : '.env',
           isGlobal: true // 全局使用
         })
       ],
       controllers: [AppController],
       providers: [AppService],
     })
     export class AppModule {}

2. 安装pnpm add @nestjs/mongoose mongoose

   • app.module.ts中使用

     @Module({
       imports: [
         ConfigModule.forRoot({
           envFilePath: process.env.NODE_ENV !== 'production' ? '.env.production' : '.env',
           isGlobal: true // 全局使用
         }),
         MongooseModule.forRoot(
           `mongodb://${process.env.DATABASE_USER}:${
             process.env.DATABASE_PASS
           }@${process.env.DATABASE_HOST}:${
             process.env.DATABASE_PORT
           }/${process.env.DATABASE_NAME}?authSource=${process.env.DATABASE_NAME}`,
           {
             connectionName: 'prankSound',
           },
         ),
       ],
       controllers: [AppController],
       providers: [AppService],
     })

文档生成

1. 安装swagger pnpm add @nestjs/swagger

2. main.ts中初始化

   文档

   import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
   async function bootstrap() {
     const app = await NestFactory.create(AppModule);
   
     // 设置swagger文档
     if (process.env.SWAGGER_ENABLED === 'true') {
       const config = new DocumentBuilder()
         .setTitle('API-SERVER')
         .setDescription('接口文档')
         .setVersion('1.0')
         .addBearerAuth()
         .build();
       const document = SwaggerModule.createDocument(app, config);
       SwaggerModule.setup('docs', app, document);
     }
     await app.listen(process.env.PORT ?? 3000);
   }