Swagger Annotation

@ApiModelProperty(example = "1")
private Long matchId;

출력되는 class에서 해당 annotation을 넣어주면 example 값이 변동된다.

위 예시처럼 Long 이지만 String으로 넣어야하며 해당 값이 Long으로 변환되어 보여진다.

 

@ApiResponses({
        @ApiResponse(code = 200, message = "!!Success!!"),
        @ApiResponse(code = 400, message = "Bad Request"),
        @ApiResponse(code = 500, message = "Internal Server Error")
})

컨트롤러에 등록하는 annotation

각 코드별 의마하는 바를 알려준다.

 

@ApiOperation(value = "Match 등록 Api", notes = "리그 경기 내역 등록 API")
@PostMapping("/setMatch")
public void getUserId(@RequestBody List<MatchDto> matchDto){
    log.info(matchDto.get(0).toString());
    dataService.setMatch(matchDto);
}

각 api 마다 달아주는 annotation 각 api마다의 설명을 추가할 수 있다.