[Spring Boot] Maven 환경에 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>

 

 

 

config라는 패키지 생성 후에 Swagger관련 코드 작성

 

SwaggerConfiguration.java

package com.springboot.hello.config;

import org.springframework.boot.autoconfigure.influx.InfluxDbOkHttpClientBuilderProvider;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.springboot.hello"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("Spring Boot Open API Test with Swagger")
                .description("설명 부분")
                .version("1.0.0")
                .build();
    }
}

 

 

 

명세의 세부 내용 설정

@ApiOperation(value="GET 메서드 예제", notes="@RequestParam을 활용한 GET Method")
@GetMapping(value="/request1")
public String getRequestParam1(
        @ApiParam(value="이름", required = true) @RequestParam String name,
        @ApiParam(value="이메일", required = true) @RequestParam String email,
        @ApiParam(value="회사", required = true) @RequestParam String organization){
    return name+" "+email+" "+organization;
}

 

@ApiOperation : 대상 API의 설명을 작성하기 위한 어노테이션

@ApiParam: 매개변수에 대한 설명 및 설정을 위한 어노테이션. 메서드 매개변수 뿐 아니라 DTO 객체를 매개변수로 사용할 경우 DTO 클래스 내의 매개변수에도 정의 가능

 

 

 

 

실행화면