Java Spring Boot

[ Swagger 사용법 ]

Santino 2024. 2. 29. 20:47

1) build.gradle에 의존성 추가

build.gradle

dependencies {
 
    // Swagger 사용 의존성
    implementation 'io.springfox:springfox-swagger2:3.0.0'
    implementation 'io.springfox:springfox-swagger-ui:2.9.2'
    
    }

 

 

2) java - common - SwaggerConfig에 해당 내용 추가

package common;


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.RequestHandler;
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 {

  private ApiInfo commonInfo(){
    return new ApiInfoBuilder()
        .title("User Api")
        .version("1.0")
        .build();
  }

    @Bean
  public Docket allApi(){
      return new Docket(DocumentationType.SWAGGER_2)
          .groupeName("USER")
          .useDefaultResponseMessages(false)
          .select()
          .apis(RequestHandlerSelectors.any())
              .paths(PathSelectors.any())
              .build()
              .aniInfo(commonInfo());
    }
}