[SpringBoot] Swagger 기본 설정

1. build.gradle에 의존성 추가

implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'	//Swagger

 

2. config 파일 생성

import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SwaggerConfig {

    @Bean
    public OpenAPI openAPI() {
        return new OpenAPI()
                .components(new Components())
                .info(apiInfo());
    }

    private Info apiInfo() {
        return new Info()
                .title("프로젝트 제목")
                .description("API 설명")
                .version("1.0.0");
    }
}

 

3. http://localhost:8080/swagger-ui/index.html 접속 (로컬 환경 아닐 경우 서버 주소:포트번호)