[RESTFUL 학습] SWAGGER

Swagger를 적용함으로써 API를 빠르게 문서화하고 명세할 수 있다.

/swagger-ui.html

Swagger를 적용 후 위와 같은 URL에 접속하면, 아래 스크린샷과 같이 생성된 API 문서를 볼 수 있다.

  

 

 

 

Swagger를 사용하는 방법은 아래와 같다.

우선 pom.xml에 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>

 

그리고 아래와 같이 Configuration(설정파일)을 생성하고 아래와 같이 작성한다.

아래 discover 메서드는 Swagger와 Hateoas를 동시에 적용했을 때 에러가 발생하기 때문에 넣은 소스이다.

Haeoas와 Swagger를 동시에 적용했을 때 아래와 같은 메시지가 발생하여 구글링 후 해결하였다.

에러메시지: 

Parameter 0 of method linkDiscoverers in org.springframework.hateoas.config.HateoasConfiguration required a single bean, but 16 were found:

 

@Configuration
@EnableSwagger2
public class SwaggerConfig {

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

    @Bean
    public LinkDiscoverers discovers() {

        List<LinkDiscoverer> plugins = new ArrayList<>();
        plugins.add(new CollectionJsonLinkDiscoverer());
        return new LinkDiscoverers(SimplePluginRegistry.create(plugins));

    }
}