[Spring Boot] Swagger Api 어노테이션

1. @EnableSwagger2어노테이션을 사용하면 Swagger관련 설정을 추가할 수 있다.

_ 원래는 스웨거 컨피그에 추가하는데 어디에 있는지 찾을수가없음.. 어딨지....

 

2. Swgger어노테이션

2-1. @Api : 클래스를 Swagger 리소스 대상으로 표시

ex) @Api(tags = "Order")

 

2-2. @ApiOperation : 요청 URL에 매핑된 API에 대한 설명

(만들어진 스웨거 api문서에서 경로옆에 api설명이 자동으로 붙는다)

ex) @ApiOperation (value = "이부분은 오더 Api입니다")

 

2-3 @ApiParam : 요청 parameter에 대한 설명, 필수여부 등 설정 

ex) public List orderApi(@ApiParam(value="테스트ID",required=true) @PathVariable ...

 

2-4 @ApiResponse : 응담에대한 설명

 

2-5 @ApiIgnore : 이 속성을 사용하면 Swagger에 보이지 않도록 숨길 수 있다.