nestjs response dto, nestjs request dto 작성법

Nestjs 에서 Rest API server 만들 때 사용하면 유용한 class validator request DTO, response DTO 사용법을 알아보겠습니다.

NestJS 로 RestAPI server 를 만들다 보면 DTO 의 유용함을 알게된다.

DTO 란 (Data Transfer Object) 계층간 데이터 교환을 위해 Data 를 변형하여 사용하는 객체를 의미한다. 여기서 계층간이란 client 와 server 간일수도 있고, server logic 과 data repository 간일수도 있다.

Nestjs 와 함께 쓰기 위한 DTO 라이브러리는 class validator 가 있다. 공식문서에서도 class-validator 를 쓰고 있다.

이 글에서는 클라이언트-서버 계층 간에서 사용되는 DTO 를 다뤄볼 것이다.

지금 프로젝트에서는 클라이언트가 요청을 보낼 때와 응답을 받을 때 필요한 DTO 를 request.dto 와 response.dto 로 구분해서 쓰고 있다.

1. nestjs request DTO

영화 OTT 서비스라고 가정해보자. 영화를 새로 추가하는 api 에는 인자값으로 영화에 대한 정보를 넣어 서버에 보내야 할 것이다. 클라이언트에서 영화 제목, 섬네일 이미지, 간략 소개를 입력해 서버에 보낼 때 POST /movie/create 라는 api 를 호출하면서 body 로 영화 제목, 섬네일 이미지, 간략 소개를 담아 보낸다.

클라이언트에서 Request 를 보낼 때는 클라이언트에서 보낸 body 가 유효한 정보들을 담고 있는 지 서버에서 반드시 확인해야 한다. 예를 들면 간략 소개글자수는 최대 100자를 넘어서는 안 되는데 클라이언트에서 100자 넘게 입력해 보냈을 때 서버에서 이를 걸러주어야 한다. 물론, 클라이언트에서 입력할 때 100자가 넘으면 submit 을 못하게 막을 수는 있지만, curl 등 api 를 바로 호출하는 경우를 대비해 이중으로 서버에서도 막아주는 것이 좋다.

또한 하나의 서버와 두 개 이상의 클라이언트가 있는 경우, POST /movie/create 라는 하나의 api 를 호출할 때에는 클라이언트들이 Request body 형식을 맞춰주어야 하는데, DTO 가 있을 경우 api 서비스 로직 호출 전에 body 를 validate 해줌으로써 클라이언트들이 제대로 형식을 맞추었는 지 validate 한 후 error 를 throw 해준다.

nestjs request DTO 작성법 예시

src/domains/movie/dto/create-movie.request.dto

import { ApiProperty } from '@nestjs/swagger';
import { IsBoolean, IsEnum, IsString, Length, Validate } from 'class-validator';
import { MovieType } from '../enum/movie-type.enum';

export class CreateMovieRequestDto {
  @ApiProperty()
  @IsString()
  @Length(1, 30, { message: 'movie 제목은 1자 이상 30자 이내여야 합니다.' })
  movieTitle: string;

	@ApiProperty()
  @IsString()
  thumbnailImage: string;

  @ApiProperty()
  @IsEnum(MovieType)
  movieType: MovieType;

  @ApiProperty()
  @IsString() 
  @MaxLength(100)
  description: string;
}

src/main.ts

app.useGlobalPipes(
    new ValidationPipe({
      // decorator 가 달린 field 만 유효성 검사를 하겠다는 옵션
      whitelist: true,
      // string 으로 들어오는 param 을 entity type 에 맞춰 변형시켜주는 옵션.
      // 예) id: number 가 param 에 string 으로 들어와도 number 로 변환시켜 controller 에 넘겨줌
      transform: true,
      exceptionFactory(errors) {
        const errorProperties = errors.map((error) => error.property);
        return new BadRequestException(
          // ex) "message": "Validation failed: ~",
          `Validation failed: ${errorProperties.join(',')}`,
        );
      },
    }),
  );

exceptionFactory 를 사용하면 validator 를 통과하지 못해 내뱉는 에러 메세지를 custom 할 수 있다.

2. nestjs response DTO

Response DTO 는 유용하다. 지금 프로젝트에서 NestJS + TypeORM 을 쓰고 있는데,

MovieModule (MovieService, MovieRepository) 에서 movie 관련 data 를 가져올 때 this.MovieRepository.find 같은 함수들을 호출한다. 이때 가져와지는 data 는 movie.entity.ts 에 선언한 데이터들이다.

영화 OTT 서비스를 만들 때 영화 목록 만 가져오는 경우가 있고, 영화 상세 정보를 가져오는 경우가 있다.

GET /movie/list 를 만들 때는 this.MovieRepository.findAll 을 할 것이고,

GET /movie/:movieId 를 만들 때는 this.MovieRepostory.find 를 할 것이다.

둘 다 movie entity 에서 가져오는 것이기 때문에 따로 selet 절을 넣지 않는 이상은 entity 통채로 가져온다.

그런데 클라이언트에서 영화 목록을 보여줄 때는 movieTitle, thumbnailImage 만 필요한데 movieType, description 까지 가져올 필요가 없다. 이럴 때 response.dto 가 유용하다.

포인트는, 같은 movie entity 를 사용하지만 영화 목록을 보여줄 때는 MovieListInfoResponseDto 를 만들어 사용하고, 영화 detail 데이터가 필요할 때는 MovieDetailResponseDto 를 구분지어 만드는 것이다.

src/domains/movie/dto/movie-list-info.response.dto

import { IsString } from 'class-validator';

export class MovieListInfoResponseDto {
  @IsString()
  readonly movieTitle: string;

  @IsString()
  readonly thumbnailImage: string;

  @Exclude()
  @IsString()
	readonly description: string;

  @Exclude()
  @IsEnum()
  readonly movieType: MovieType
}

src/domains/movie/dto/movie-detail.response.dto

import { IsEnum, IsString, Exclude } from 'class-validator';
import { MovieType } from '../enum/movie-type.enum';

export class MovieDetailResponseDto {
  @IsString()
  readonly movieTitle: string;

  @IsString()
  readonly thumbnailImage: string;

  @IsString()
	readonly description: string;

  @Exclude()
  @IsEnum()
  readonly movieType: MovieType
}

@Exclude() 데코레이터를 빼고 싶은 필드에 붙여주면 된다.

위처럼 dto 를 만들고, 서비스 로직에서 아래처럼 해주면 된다.

/src/domain/movie/service.ts
import { plainToInstance } from 'class-transformer';
import { MovieListInfoResponseDto } from './dto/movie-list-info.response.dto

async getMovieList = () => {
	...
  const movies = await this.movieRepository.findAll({
    where: {
			 ... 
     }
  })

  return plainToInstance(MovieListInfoResponseDto, movies);
}

결과

{ movieTitle: ‘Avatar2’, thumbnailImage: ‘~’}

Reference

https://docs.nestjs.com/techniques/validation

nestjs ejsadapter 사용해서 email 보내기

nestjs env variable troubleshooting

TypeORM soft delete on cascade

tyepORM entity 에서 비밀번호 hash 하기