Swagger 3 적용하기

1. 의존성 추가

build.gradle

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

해당 버전은 아래에 있는 라이브러리를 포함하고 있어 한 줄만 추가하면 된다.

https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter/3.0.0

2. Config

클래스 어노테이션

@Configuration
@EnableWebMvc
public class SwaggerConfig { }

Swagger UI 화면 정보 설정하기

private ApiInfo SwaggerApiInfo(){
  Contact contact = new Contact("SpringStudy", "<https://github.com/ywoo-srin-minj/spring_study>", "[email protected]");
	// name, url, email
  return new ApiInfoBuilder()
          .title("Spring Study API")
          .description("Spring Study")
          .version("1.0")
          .contact(contact)
          .build();
}

UI 화면에서 나타나는 제목, 설명, 버전, 콘택트 정보를 추가할 수 있다.

Docket

@Bean
public Docket SwaggerApi(){
    return new Docket(DocumentationType.OAS_30)
            .groupName("Study API")
            .useDefaultResponseMessages(false)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.second.spring_study.controller"))
            .paths(PathSelectors.any())
            .build()
            .apiInfo(SwaggerApiInfo());
}