[Spring boot] Swagger 설정하기 (gradle)

[1] gradle dependency 찾기

mvn repository 에 들어가 원하는 버전을 선택한다.

swagger2 버전을 선택함

 

[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.yooha"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("yooha Spring Boot REST API Test")
                .version("1.0.0")
                .description("두유의 swagger 테스트")
                .build();
    }
}

[4] Swagger 페이지 확인

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

[5] Swagger 적용

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

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

 

출처 : https://velog.io/@borab/Spring-boot-Swagger-%EC%84%A4%EC%A0%95-gradle