[Spring boot] swagger 기본 설정

build.gradle dependencies에 다음 추가

dependencies {
	...
    
	// swagger ui
	implementation 'io.springfox:springfox-boot-starter:3.0.0'
	implementation 'io.springfox:springfox-swagger-ui:3.0.0'
}

 

SwaggerConfig.java

package com.example.simpleBoard;

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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2
@Configuration
public class SwaggerConfig {

    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo()) //api 문서에 대한 정보
                .select() //ApiSelectionBuilder 반환
                .apis(RequestHandlerSelectors.basePackage("com.example.simpleBoard")) //api 문서화 적용대상 패키지 설정 any(), none()
                .paths(PathSelectors.ant("/api/**")) //api 문서화 적용대상 url path 설정 any(), none()
                .build(); //springfox builder docket 생성
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("simpleBoard API")
                .description("간단한 게시판 기능 api")
                .contact(new Contact("seungmin","https://seungmin-archive.tistory.com",""))
                .version("1.0")
                .build();
    }
}

 

controller method에 ApiOperation으로 swagger 설정 적용

@RequiredArgsConstructor
@RestController
public class PostApiController {    
    
    ...
    
    @ApiOperation("post 등록")
    @PostMapping("api/v1/post")
    public Long savePost(@RequestBody PostSaveRequestDto requestDto){
        return postService.save(requestDto);
    }
    
    ...
}

 

spring boot 2.6 이상에서 필요한 설정

application.yml에 다음 추가

spring:
	mvc:
    		pathmatch: 
        		matching-strategy: ant_path_matcher

 

로컬 실행 시 다음 주소로 이동하여 확인: http://localhost:8080/swagger-ui/index.html

swagger ui 페이지