RestFul API 연습(9) Swagger 사용

Swagger란 개발한 REST API를 편리하게 문서화 해주고, 이를 통해서 편리하게 API를 호출해보고 테스트할 수 있는 프로젝트이다. 기본 swagger2 프로젝트 뿐 아니라 다양한 구성을 가지고 있다

API Documentation & Design Tools for Teams | Swagger

 

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>

우선 이 두가지를 pom.xml에 적용시켜 보자 

 

그렇게 하면 메이븐에서 Swagger를 사용할 수 있게 된다. 

 

일단 config를 하나 생성해주자 

 

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)

}

이렇게 하면 완료 된다.

 

이렇게 편하게 문서 자동화가 가능하다.