[Swagger] Default 값, 예시 값 설정하기

백엔드에서 API를 문서화하기 위해서 Swagger API를 사용할 수 있습니다. 이때 Swagger 문서에서 테스트를 편하게 하기 위해서 Default 값이나 예시 값을 넣는 방법을 설명하겠습니다. 

 

주의해야 할 점은 Default 값은 사용자 요청에서 특정 값이 생략되었을 때 사용되는 값이고, 예시 값은 API 문서에서만 사용되는 값이라는 것입니다. Default 값은 실제로 API 통신에 영향을 미치지만, 예시 값은 영향을 미치지 않습니다. 

 

다음은 Default 값과 예시 값을 Swagger API에 어떻게 설정할 수 있는지 보여주는 Nest.Js + Typescript의 예시입니다.

> Default 값

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

export class CreateUserDto {
  @ApiProperty({ description: '사용자의 이름', default: '홍길동' })
  name: string;

  @ApiProperty({ description: '사용자의 나이', default: 20 })
  age: number;

 

 

> 예시 값

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

export class CreateUserDto {
  @ApiProperty({ description: '사용자의 이름', example: '홍길동' })
  name: string;

  @ApiProperty({ description: '사용자의 나이', example: 25 })
  age: number;
}