Nest.js Swagger 사용법

Nest.js 설치 및 설정

@nestjs/swagger를 설치합니다.

yarn add @nestjs/swagger

main.ts에 swagger를 적용합니다.

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

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

  const config = new DocumentBuilder()
    .setTitle('OctoDocs')
    .setDescription('OctoDocs API 명세서')
    .build();
  const documentFactory = () => SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('api', app, documentFactory);
  await app.listen(3000);
}
bootstrap();

@ApiOperation 데코레이터를 사용하면 각 api 별로 설명을 쓸 수 있습니다.

  @ApiOperation({ summary: '페이지를 생성하고 노드도 생성합니다.' })
  @Post('/')
  @HttpCode(HttpStatus.CREATED)
  async createPage(@Body() body: CreatePageDto): Promise<{ message: string }> {
    await this.pageService.createPage(body);
    return {
      message: PageResponseMessage.PAGE_CREATED,
    };
  }