[Swagger] @ApiModelProperty

@ApiModelProperty

• Swagger UI와 같은 API 문서화 도구에서 API 엔드포인트와 관련된 모델 속성을 설명하는 데 사용되는 애노테이션(annotation)

@ApiModelProperty(
  value = "first name of the user", // 설명(값)
  name = "firstName", // 이름
  dataType = "String", // 데이터 유형
  example = "Hong") // 예제 값 및 모델 속성에 허용되는 값
String firstName;

• value
  : 필드 또는 메서드에 대한 설명

• name
  : 필드 또는 메서드의 이름, 기본값은 필드 또는 메서드의 이름과 동일(생략 가능)

• dataType
  : 필드 또는 메서드의 데이터 유형을 지정
  ex. dataType = "java.lang.String", dataType = "java.util.Date"
  

• allowableValues
  : 필드 또는 메서드가 가질 수 있는 값의 목록을 지정
  : API 사용자가 입력 가능한 값의 범위를 제한할 수 있다

• required
  : 필드 또는 메서드가 필수인지 여부, 기본값 = false (생략 가능)

• readOnly
  : 필드 또는 메서드가 읽기 전용인지 여부, 기본값 = false (생략 가능)

• example
  : 필드 또는 메서드에 대한 예제 값을 제공

• hidden
  : 필드 또는 메서드를 문서에서 숨길지 여부, 기본값 = false (생략 가능)