스웨거는 Open Api Specification(OAS)를 위한 프레임워크다. url 리스트를 html화면으로 문서화 및 테스트할 수 있는 라이브러리. 즉, 상대 개발자한테 스웨거만 전달해주면 API path, Request, Response값 및 제약 등을 한번에 알려줄 수 있음
OAS : RESTful 웹서비스를 양식에 맞게 API스펙을 json과 yaml 형식으로 표현한다. 즉, 추가적인 설명없이 서비스를 이해할 수 있게 됨.
스웨거 기능
<!-- swagger 설정 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
spring.mvc.pathmatch.matching-strategy=ant-path-matcher 추가
해당 설정은 스프링 버전과 dependency로 불러온 스웨거 버전의 호환문제가 생길 수 있으므로 해주는 설정이다.
Docket(DocumentationType.SWAGGER_2) : swagger 설정 필수로 Bean으로 등록해줘야 한다, 파라미터는 swagger 버전에 맞춰 설정해준다
@ApiIgnore :
@ApiModel :
@ApiModelProperty :
@ApiOperation :
@ApiResponses : 200,404,500 등등의 상황에 따라 표시할 내용
localhost:port번호/swagger-ui.html 접속!!!
스프링부트 버전에 따라 오류가 생기는 경우가 있다고 한다!
application.properties에 spring.mvc.pathmatch.matching-strategy=ant-path-matcher를 추가시켜줘야함!