Spring boot Swagger 설정 (gradle) 🐏

❗ 스프링 부트 swagger를 설정해보자

1. 사용할 gradle dependency 찾기

gradle 디펜던시 참고 에 들어가서 원하는 버전으로 선택해서 들어간다.

가장 많이 사용한듯 한 2.9.2를 골랐다.

2. 페이지에 나오는 gradle 의존성을 내 프로젝트 build.gradle에 추가한다.

추가로 위에 의존성을 복사해 swagger2도 임포트 해준다.

//https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui
implementation group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.9.2'
implementation group: 'io.springfox', name: 'springfox-swagger2', version: '2.9.2'

3. SwaggerConfig를 만든다.

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

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

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("hobbybee Spring Boot REST API")
                .version("1.0.0")
                .description("취미 생활 커뮤니티 hobbybee의 swagger api 입니다.")
                .build();
    }
}

• 주요 옵션
  • apis : 대상 패키지 설정
  • paths : 어떤 식으로 시작하는 api 를 보여줄것인지?
    any는 그냥 전부다. 만약, member/ 라고 설정하면 member로 시작하는 api 만 볼 수 있게 설정 가능하다.

4. web page 접속

http://localhost:8090/swagger-ui.html

5. 적용 확인

@RestController
@RequestMapping(value = "/member/v1")
@Api(tags = {"회원가입 API"})
@RequiredArgsConstructor
public class JoinController {

    @PostMapping(value = "/join")
    @ApiOperation(value = "회원가입", response = Join.class)
    public ResponseEntity<T> signUp() {
    
    }
    
 }