API 명세 툴 Swagger 연동

1. 의존성 추가

1) pom.xml

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.6.0</version>
</dependency>

2) build.gradle

dependencies {
    implementation 'springdoc:springdoc-openapi-ui:2.6.0'
    // 다른 필요한 의존성들...
}

 

2. SwaggerConfiguration.java

@Configuration    // 스프링 실행시 설정파일 읽어드리기 위한 어노테이션
public class SwggerConfiguration {
    @Bean
    public OpenAPI openAPI() {
        return new OpenAPI()
                .components(new Components())
                .info(apiInfo());
    }

    private Info apiInfo() {
        return new Info()
                .title("Swagger Test")
                .description("스프링부트 공부중! Swagger 연동 테스트")
                .version("1.0.0");
    }
}

 

3. GUI Swagger 접속

http://서버주소:포트번호/swagger-ui/index.html 에 접속한다.