Backend/SPRING

Swagger에서 Enum을 표기하는 방법 / The way express Enum in Swagger

GreatSaiyaman 2022. 5. 31. 18:54

Swagger에서 주로 하는 고민은 프로젝트 전반적으로 쓰이는 DTO/VO를 어떻게 이쁘게 표현해줄까?

일텐데요. Enum에 대해서 단순하게 표기했다가, 우연히 방법을 찾게되어 공유드립니다.

DTO/VO에 속하는 Enum값들을 표기하는 방법입니다.

@ApiModelProperty(
            value = "해당 값에 대한 설명"
            , example = "실제 예제로 들어갔으면 하는 값"
            , required = true
            , allowableValues = "FIRST_TYPE, SECOND_TYPE"
)
AnyTypeEnum anyTypeEnum;

FIRST_TYPE, SECOND_TYPE에 실제 ENUM값을 적어주시면 됩니다.

DTO/VO 자체를 표기하는 방법에 대해서는 다른 포스팅에서 다루겠습니다.

감사합니다.