Swagger - API 문서 꾸미기

 

	@ApiImplicitParams(
        {
            @ApiImplicitParam(name="prdtCd", value = "제품코드", dataType = "String", paramType = "query"),
            @ApiImplicitParam(name="prdtNm", value = "제품명", dataType = "String", paramType = "query"),
            @ApiImplicitParam(name="filter", value = "검색어", dataType = "String", paramType = "query")
        }
    )
    @RequestMapping(method = RequestMethod.GET, produces = APPLICATION_JSON)
    public Responses.ListResponse list(RequestParams<Product> requestParams) {
        List<Product> list = productService.gets(requestParams);
        return Responses.ListResponse.of(list);
    }

 

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

 

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

 

현재 name, value, dataType, paramType 을 쓰고 있지만 더 많은 옵션들이 있음.

ex) boolean 형식의 required = 를 사용하여 값 입력 요구 할 수 있음.

 

 

결과창

Parameters 항목에 코드로 설정했던 옵션들이 들어왔다.

 

filter 에 값을 넣고 Try 를 하면 실제 값이 들어가서 filter한 결과를 보여준다.

아무값도 안넣고 그냥 Try 했을 경우에는 전체 리스트를 뿌리는 코드라서 전체 리스트를 가져온다.

 

 

더 많은 옵션에 대한 설명

https://velog.io/@gillog/Swagger-UI-Annotation-%EC%84%A4%EB%AA%85

[Swagger UI] Annotation 설명