[Swagger] Missed comma between flow collection entries

개요

알림 기능 개발 이후 Swagger에서 "missed comma between flow collection entries" 오류가 발생했습니다. 해당 오류를 해결한 경험을 공유하고자 합니다.

 

[트러블 슈팅] Missed comma 

문제 상황 : 스웨거 접속시 파싱 에러가 발생한다.

 

"Missed comma" 메시지를 처음 접했을 때 단순히 콤마(comma)만을 의미하는 것으로 이해했지만, 실제로는 콤마뿐만 아니라 따옴표, 대괄호 등 다양한 구문 요소를 포함하여 발생한 오류임을 알게 되었습니다. 이로 인해 Swagger에서 문제가 발생한 것입니다. 

저의 경우에는 "@ApiModelProperty"의 example 설정 문제로 발생했습니다.

 

해결 방안 : 속성 값 comma를 수정한다.

// .. 생략

@ApiModelProperty(value = "Push ID", example = "4")
private final Long id;

@ApiModelProperty(value = "제목", example = "[재입고 알림] 상품 재입고 안내")
private final String title;

@ApiModelProperty(value = "내용", example = "재입고 안내드립니다.")
private final String content;

// .. 생략

문제가 발생한 부분은 @ApiModelProperty(value = "제목", example = "[재입고 알림] 상품 재입고 안내") 입니다. example 속성을 작성할 때 대괄호가 포함될 경우 작은 따옴표를 작성해서 감싸줘야합니다. 

@ApiModelProperty(value = "제목", example = "'[재입고 알림] '상품 재입고 안내")의 형태로 변경하였습니다.