[Swagger] DTO에서 parameter 숨기기

특정 DTO 필드 Parameter Swagger 문서상에서 Hidden 시키기

 

 

Request DTO에서 Parameter 하나를 추가해 쿼리를 돌리려하는데 몇가지 고민이 생겼습니다.

 

 

1. 요청받을 정보에는 필요없지만 쿼리문을 태울땐 필요한 파라미터가 하나 있다.

 

 

2. DTO에 넣자니 swagger에 보여서 싫고, 받은 DTO를 Map이나 또 다른 DTO를 만드는 것도 싫다.

    (Parameter 하나만 추가되기 때문)

 

 

3. 요약 : DTO에 parameter를 추가하되 swagger에 보이고 싶지 않다!

 

 

 

여러가지를 써본 결과 제일 간단한 방법을 찾아서 공유해봅니다.

 

public static class UserDto {
	private String name;
    
	@ApiModelProperty(hidden = true)
	private Integer age;
}

숨기고 싶은 parameter에

@ApiModelProperty(hidden = true)

어노테이션과 hidden 설정을 해주시면 됩니다!!

 

 

끝!!