Spring Boot + Swagger에서 생성한 문서의 요청 매개변수 Description 지정

Spring Boot + SpringFox에서 Swagger를 사용하여 소스에서 API 큐먼트 생성 에서 올린 내용의 관련 기사가 됩니다.

Swagger에서 생성한 문서에서 GET 요청의 요청 매개변수 설명은 기본적으로 매개변수 이름입니다. 아래 이미지와 같은 형태입니다.


이 Description을 좀 더 알기 쉬운 내용으로 하고 싶은, 어떤 때가 있을까 생각합니다. 아래 이미지와 같은 형태입니다.


이런 경우 Spring Boot에서는 다음과 같이 설명합니다.

UserController.java

    @ApiOperation(value = "${UserController.getUser.value}", notes = "${UserController.getUser.notes}")
    public User getUser(@ApiParam(value = "ユーザID", required = false) @RequestParam("id") String id) {
        return new User(id, "ichiro");
    }

@ApiParam (value = "사용자 ID", required = false)
의 부분이 그에 해당합니다. 이와 같이 기재하는 것으로 상기의 화상과 같은 Description이 됩니다.

이상입니다.