[Springboot] 자바 스프링부트 Swagger 기본 설정

 

 

풀스택 미니 프로젝트를 진행하면서 메모하는

자바 스프링부트 스웨거 설정

 

🔥 기본 URL = http://localhost:8080/swagger-ui/index.html#/

 

경로

🔥 디렉토리 = java/com/example/{프로젝트 이름}/global/config

 

🔥 build.gradle 의존성 추가 내용

// swagger
   implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.7.0'

 

 

🔥 SwaggerConfig 기본 코드

package com.example.kiosk_be.global.config;

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

@Configuration
@ComponentScan(basePackages = {"com.example.kiosk_be.domain.*.controller"})
@OpenAPIDefinition(
        info = @Info(
                title = "Kiosk Project",
                description = "This Project is simple kiosk service",
                version = "1.0.0"
        )
)
public class SwaggerConfig {
    @Bean
    public OpenAPI openAPI() {
        return new OpenAPI().components(new Components());
    }
}