[NestJS] Swagger 적용하기

Swagger

swagger에 대한 설명은 여기😀

NestJS에서 Swagger 설치

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

NestJS에서 Swagger 사용하기

• main.ts에서 SwaggerModule를 사용해서 초기화한다.

  const config = new DocumentBuilder()
    .setTitle('AH-HA API docs')
    .setDescription('The AH-HA API description')
    .setVersion('1.0')
    .addBearerAuth()
    .build();

  const document = SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('api/v1/docs', app, document);

Swagger에서 제공하는 API 응답 데코레이터

@ApiOkResponse() // status code 200
@ApiCreatedResponse() // status code 201
@ApiAcceptedResponse()
@ApiNoContentResponse()
@ApiMovedPermanentlyResponse()
@ApiBadRequestResponse()
@ApiUnauthorizedResponse() // status code 401
@ApiNotFoundResponse()
@ApiForbiddenResponse()
@ApiMethodNotAllowedResponse()
@ApiNotAcceptableResponse()
@ApiRequestTimeoutResponse()
@ApiConflictResponse()
@ApiTooManyRequestsResponse()
@ApiGoneResponse()
@ApiPayloadTooLargeResponse()
@ApiUnsupportedMediaTypeResponse()
@ApiUnprocessableEntityResponse()
@ApiInternalServerErrorResponse()
@ApiNotImplementedResponse()
@ApiBadGatewayResponse()
@ApiServiceUnavailableResponse()
@ApiGatewayTimeoutResponse()
@ApiDefaultResponse()

• 있는거 없는거 다 있다!

더 많은 decorator는 여기를 참고하자.

https://docs.nestjs.com/openapi/decorators