[Nest.js] 스웨거 사용시 순환 참조 에러(enum 사용할 경우)

nestjs에서 스웨거 사용시 아래와 같은 순환 참조 에러가 발생했다.

nestjs의 공식 홈페이지에서는 밑에 에러와 동일하게 type: () => ClassType 을 하라고 한다.

하지만, 나같은 경우에는 그게 해결이 되지 않아 다른 방법을 찾았다.

 

 

에러

Error: A circular dependency has been detected (property key: "SOCCER"). Please, make sure that each side of a bidirectional relationships are using lazy resolvers ("type: () => ClassType").

 

 

 

 

---

 

 

 

변경 전 코드

enum CategoryType {
  SOCCER = 'SOCCER',
  BASEBALL = 'BASEBALL',
}
 
export class Model {
  @IsString()
  @IsNotEmpty()
  @ApiProperty({
    type: String,
    required: false,
    default: '',
    maxLength: 10,
    description: '제목은 최대 10자입니다.',
  })
  public title!: string;
 
  @ApiProperty({
    type: String,
    required: false,
    default: '',
  })
  public contents!: string;
 
  @IsEnum(CategoryType)
  @ApiProperty({
    type: CategoryType,
    required: true,
  })
  public category!: CategoryType;
}

 

 

변경 후 코드

enum CategoryType {
  SOCCER = 'SOCCER',
  BASEBALL = 'BASEBALL',
}
 
export class Model {
  @IsString()
  @IsNotEmpty()
  @ApiProperty({
    type: String,
    required: false,
    default: '',
    maxLength: 10,
    description: '제목은 최대 10자입니다.',
  })
  public title!: string;
 
  @ApiProperty({
    type: String,
    required: false,
    default: '',
  })
  public contents!: string;
 
  @IsEnum(CategoryType)
  @ApiProperty({
    enum: [
      'SOCCER',
      'BASEBALL'
    ],
  })
  public category!: CategoryType;
}

 

 

 

해결에 대한 설명

nestjs에서 설명하는 순환참조는 클래스간의 문제이기 때문에 적용이 되지않았다.

다만, enum방식을 그대로 적용했더니 동작이 가능해졌다.