[Nest.js] Swagger사용 방법

nest js 공식 문서에 OPEN API

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

설치 한다. 

 

main.ts 

main.ts에서

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

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

  const config = new DocumentBuilder()
    .setTitle('여기는 타이틀')
    .setDescription('여기는 설명란')
    .setVersion('2.3.4')
    .addTag('여기는 태그')
    .build();

  const document = SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('docs', app, document);
}
bootstrap();

이제 실행을 해보자. 

npm run start:dev

 

실행화면 

SwaggerModule.setup('docs', app, document);
// 함수의 첫번째 파라미터가 엔드포인트가 된다.

 

이상 설정하는 방법이다.