[Spring Boot] Gradle 환경에 Swagger 적용하기

build.gradle 에 아래와 같이 추가한다. 

최신 버전인 3.0.0을 사용한다. 

implementation 'io.springfox:springfox-boot-starter:3.0.0'

 

 

config 파일에 SwaggerConfiguration.java를 작성한다. 

package com.toy.projectmate.config;

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;

@Configuration
public class SwaggerConfiguration {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.OAS_30)
                .useDefaultResponseMessages(false)// 기본 응답 코드
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.toy.projectmate")) // 스캔할 패키지 범위
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() { // swagger ui로 노출할 정보
        return new ApiInfoBuilder()
                .title("Swagger Test")
                .description("설명 부분")
                .version("3.0")
                .build();
    }
}

 

 

어플리케이션을 실행한 후 

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

로 이동하면 swagger ui를 통해 api를 테스트 해볼 수 있다. 

 

 

 

명세 추가하기 

@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 클래스 내의 매개변수에도 정의 가능