Swagger UI 꾸미기

Swagger

Swagger란 서버로 요청되는 URL 리스트를 HTML화면으로 문서화 및 테스트 할 수 있는 라이브러리이다.

간단하게 설명하면 Swagger는 API Spec 문서이다.

API를 엑셀이나 가이드 문서를 통해 관리하는 방법은 주기적인 업데이트가 필요하기 때문에 관리가 쉽지 않고 시간이 오래 걸린다.

그래서 Swagger를 사용해 API Spec 문서를 자동화해주어 간편하게 API문서를 관리하면서 테스트할 수 있다.

 

---

아직 아무것도 하지 않은 상태이다.

 

 

@ApiOperation(value = "전체 글가져오기", notes = "BD에 저장된 게시글을 전부 조회합니다")

Method의 대한 설명을 작성한다.

 

 

@ApiImplicitParams({
        @ApiImplicitParam(name = "name", value = "value", defaultValue = "defaultValue")
})

Request Parameter 설명을 작성한다.

 

@ApiImplicitParams = 여러개의 파라미터 설명을 달때 필요

 

@ApiImplicitParam = 하나의 파라미터에 관한 설명을 달 수 있음.

 

전체적인 설명을 추가한 결과

 

---

 

참고

@ApiOperation(
        value = "자격증 정보 조회"
        , notes = "자격증의 ID를 통해 자격증의 정보를 조회한다.")
    @ApiImplicitParams(
        {
            @ApiImplicitParam(
                name = "id"
                , value = "자격증 아이디"
                , required = true
                , dataType = "string"
                , paramType = "path"
                , defaultValue = "None"
            )
        ,
            @ApiImplicitParam(
                name = "fields"
                , value = "응답 필드 종류"
                , required = false
                , dataType = "string"
                , paramType = "query"
                , defaultValue = ""
            )
        })
    @GetMapping("/licenses/{id}")
    @ResponseBody
    public UserDTO getLicense(@PathVariable(name = "id") String id, @RequestParam(name = "fields", required = false) String fields) {
        retur