[SpringBoot]Swagger 설정(intellij 기준)

Swagger OpenApi

• Rest Api 명세화 시키기

• 기본 설정 (Intellj 기준)

  • Intellij Ultime
  • 빌드 : Maven
  • SpringBoot Version : 3.0.1
  • plugin : auto

설정하기

• 의존성 추가(dependency)
  • pom.xml 추가

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

• config 생성
  • boot 패키지 안에 config 패키지 생성
  • config 패키지에 SwaggerConfig 클래스 생성

        package com.springboot.api.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("Springdoc 테스트")
                .description("Springdoc을 사용한 Swagger UI 테스트")
                .version("1.0.0");}} 

@Configuration annotation 클래스 명위에 기재
@Bean OpenAPI 객체 생성
import할 시 패키지 확인 필수
Info 는 메인 화면에 게시될 문자열

• 접속 경로
  • http://localhost:8080/swagger-ui/index.html
  • http://localhost:8080/swagger-ui.html
    버전별로 상이하다고 하는데 두개의 주소 접속 이상없음.

appilcation.properties 설정은 좀 더 확인 후 추가, 해당 클래스마다 설명쓰는 내용도 추가하기