[SpringBoot] Swagger 설정하기

 

dependency 추가

먼저 스웨거 디펜던시를 추가한다. build.gradle 파일에 라이브러리를 추가해준다.

필요한 라이브러리의 디펜던시는 하위 링크에서 쉽게 찾을 수 있다.

https://mvnrepository.com/artifact/io.springfox/springfox-swagger2/2.9.2

Maven Repository: io.springfox » springfox-swagger2 » 2.9.2

...
repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.springframework.boot:spring-boot-starter-aop'
    implementation 'org.springframework.kafka:spring-kafka'
    implementation 'org.projectlombok:lombok'
    // swagger
    implementation group: 'io.springfox', name: 'springfox-swagger2', version: '2.6.1'
    implementation group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.6.1'
    testImplementation 'org.springframework.kafka:spring-kafka-test'
}
...

// swagger 밑의 두 줄을 입력해주고, Load Gradle Changes를 해준다.

swagger-ui는 스웨거가 생성하는 API 문서를 사용자 대화방식으로 더 쉽게 만들어 주는 내장 솔루션이다.

 

SwaggerConfig.java 파일 생성

package com.kiwius.kafka.config;

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.basePackage("com.kiwius.kafka")).paths(PathSelectors.any())
                .build();
    }
}

• @Configuration 어노테이션
  스프링 IOC Container에게 해당 클래스를 Bean 구성 클래스임을 알려준다.
• @Bean 어노테이션
  @Component 어노테이션 둘 다 IOC Container에 Bean을 등록하도록 하는 메타데이터를 기입하는 어노테이션이다.
  다른 점은 @Bean은 개발자가 직접 제어가 불가능한 외부 라이브러리 등을 Bean으로 만들 때 사용한다.
  반대로 @Component는 개발자가 직접 작성한 클래스를 Bean으로 등록할 때 사용한다.
• 해당 config 파일을 통해 basePackage 하위의 Rest API가 Swagger를 통해 관리된다.

 

swagger-ui.html 접속

• http://localhost:8080/swagger-ui.html에 접속해 확인한다.