Swagger UI (=Springdoc OpenAPI ) 설정하기

간만에 Swagger 를 설정하려고 하니  스프링 2.6 이상부터는 Spring-Doc 으로 해야한다길래 기록해둔다. 

https://velog.io/@jeong-god/Spring-boot-Swagger-API-%EC%97%B0%EB%8F%99%ED%95%98%EA%B8%B0

 

환경 
스프링 boot 버전 : 2.7.12 , 

그레이들 : 7.6

우선 build.gradle 에  의존성 추가 

   implementation 'org.springdoc:springdoc-openapi-ui:1.7.0'

config 패키지에 OpenApiConfig.java 파일 추가 

@Configuration
public class  OpenApiConfig {
    @Bean
    public GroupedOpenApi publicApi() {
        return GroupedOpenApi.builder()
                .group("v1-definition")
                .pathsToMatch("/api/**")
                .build();
    }
    @Bean
    public OpenAPI springShopOpenAPI() {
        return new OpenAPI().info(new Info().title("API").description(" API 명세").version("v0.1"));
    }
}

 

이렇게 하고 링크에서 보여준것처럼   각자 상황에 맞게  Controller 추가한 후에 

 

http://<스프링 부트 url> /swagger-ui/index.html
접근하면 예전에 보던 Swaager 화면이 뜬다.! 

 

 

 

https://blog.jiniworld.me/83?category=850715#a02-1 어노테이션 관련 설명 잘되어있는 글