[Swagger2] REST API 문서화

1. Swagger2 

REST API 문서화 도구

스프링 부트 환경에서 사용 가능함 (스프링 부트가 아닌 환경에서도 가능)

2. Maven Dependency 추가 

<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>

3. Java 설정

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.PathSelectors;

import springfox.documentation.builders.RequestHandlerSelectors;

import springfox.documentation.spi.DocumentationType;

import springfox.documentation.spring.web.plugins.Docket;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration

@EnableSwagger2

public class SwaggerConfig {

@Bean

public Docket api() {

return new Docket(DocumentationType.SWAGGER_2)

.select()

.apis(RequestHandlerSelectors.any())

.paths(PathSelectors.any())

.build();

}

}

4. 확인

스프링 부트 실행 후, http://localhost:포트/swagger-ui.html 접속

참고 : 

https://www.baeldung.com/swagger-2-documentation-for-spring-rest-api

https://jojoldu.tistory.com/31

(스프링 부트가 아닌 환경)https://edwin.baculsoft.com/2016/09/integrating-swagger-2-and-spring-mvc-4/