nest.js配置快速生成swagger API文档

import { Module } from '@nestjs/common';
import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
 
// 假设这是你的应用模块 AppModule
@Module({
  // ... (你的模块配置)
})
export class AppModule {
  // 在Nest应用启动时，配置并启动Swagger
  constructor(private readonly document: DocumentBuilder) {}
 
  configureSwagger() {
    const config = new DocumentBuilder()
      .setTitle('Cats example') // 设置API文档标题
      .setDescription('The cats API description') // 设置API文档描述
      .setVersion('1.0') // 设置API文档版本
      .addTag('cats') // 添加标签
      .build();
    const document = SwaggerModule.createDocument(this, config);
    SwaggerModule.setup('api', this, document);
  }
}

在Nest应用的main.ts中启动应用之前调用configureSwagger方法：

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
 
async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  // 启动Swagger
  new AppModule().configureSwagger();
  await app.listen(3000);
}
bootstrap();

这段代码演示了如何在Nest.js应用中配置和启动Swagger，以自动生成API文档。在AppModule中定义了Swagger的配置，并且在应用启动前调用了configureSwagger方法。这样，当应用启动后，你可以通过访问http://<host>:<port>/api来查看生成的API文档。