Springboot REST 서비스API웹페이지만들기

3분만에 Swagger 적용하기

Springboot에서 REST 서비스를 만들고나면 REST에 접근하기 위한 명세를 배포해야 하는데 Swagger을 사용하면 배우 간편하고 이쁘게 배포할 수 있다. 아래 링크는 swagger를 사용한 예다.(공식홈의 livedemo)

Swagger UI

이걸 매우 빠르게 Springboot 웹 프로젝트에 적용하는 방법을 알아보자. 디테일하게 하려면 이것저것 고칠게 많지만 일단은 먼저 적용부터 하고나서 고민할 일이다. 3분이면 충분하다.

1. pom.xml에 아래 의존성을 추가하자

<dependency>

    <groupId>io.springfox</groupId>

    <artifactId>springfox-swagger2</artifactId>

    <version>2.4.0</version>

</dependency>

<dependency>

    <groupId>io.springfox</groupId>

    <artifactId>springfox-swagger-ui</artifactId>

    <version>2.4.0</version>

</dependency>

2. config class를 추가하자

@Configuration

@EnableSwagger2

public class SwaggerConfig {

    @Bean

    public Docket api() {

        return new Docket(DocumentationType.SWAGGER_2)

            .select()

            .apis(RequestHandlerSelectors.any())

            .paths(PathSelectors.any()).build();

    }

}

3. 실행 확인

Spring boot 프로젝트를 실행하고 나서 아래 주소로 접속한다.

http://localhost:8080/swagger-ui.html