Nestjs에 swagger 적용

npm install --save @nestjs/swagger swagger-ui-express

[ src/swagger.document.ts ]

import { DocumentBuilder } from '@nestjs/swagger';

export class BaseAPIDocument {
    public builder = new DocumentBuilder();

    public initializeOptions() {
        return this.builder
            .setTitle('Swagger Example')
            .setDescription('Swagger API doc')
            .setVersion('1.0.0')
            .addTag('swagger')
            .build();
    }
}

[ src/main.ts ]

import { NestFactory } from '@nestjs/core';
import { SwaggerModule } from '@nestjs/swagger';
import { AppModule } from './app.module';
import { BaseAPIDocument } from './swagger.document';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.setGlobalPrefix('api');

  const config = new BaseAPIDocument().initializeOptions();
  const document = SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('swagger',app, document);
  
  await app.listen(5001);
}
bootstrap();

[ src/main.ts ]

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.setGlobalPrefix('api');

  const config = new BaseAPIDocument().initializeOptions();
  const document = SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('api/swagger',app, document);
  
  await app.listen(5001);
}

app.setGlobalPrefix를 줬기 때문에 swagger 경로에 앞에 api를 꼭 붙여줘야 접속 된다.