[SpringBoot] Swagger

0. Swagger( 스웨거 )?

개발자 : 스마트베어 소프트웨어(SmartBear Software)
발표일 : 2011년
라이센스 : 아파치 라이선스 2.0
웹사이트 : swagger.io

스웨거(Swagger)는 개발자가 REST 웹 서비스를
설계, 빌드, 문서화, 소비하는 일을 도와주는
대형 도구 생태계의 지원을 받는 오픈 소스 소프트웨어 프레임워크이다.
대부분의 사용자들은 스웨거 UI 도구를 통해 스웨거를 식별하며
스웨거 툴셋에는 자동화된 문서화, 코드 생성, 테스트 케이스 생성 지원이 포함된다.

스마트베어 소프트웨어의 후원을 받는 스웨거는
오픈 소스 소프트웨어의 튼실한 후원자이며 널리 채택되고 있다.

---

1. pom.xml에 <dependency> 추가하기

-pom.xml의 <dependencies>태그안에

 Swagger <dependency>를 추가해준다

<!-- 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>
<dependency>
  <groupId>org.bitbucket.tek-nik</groupId>
  <version>1.0.2</version>
  <artifactId>spring-swagger-simplified</artifactId>
</dependency>

---

2. SwaggerConfig.java( Swagger설정파일 )을 만들어 준다

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2).select()
                .apis(Predicates.not(RequestHandlerSelectors.
                        basePackage("org.springframework.boot")))
                .paths(PathSelectors.any()).build();
    }
}

---

3. Swagger UI 페이지를 확인한다

 http://localhost:포트/swagger-ui.html

Swagger UI