• 완성 코드: GitHub

Swagger UI란?

• REST 웹 서비스를 설계, 빌드, 문서화, 소비하는 일을 도와주는 대형 도구 생태계의 지원을 받는 오픈 소스 소프트웨어 프레임워크
• 자동화된 문서화, 코드 생성, 테스트 케이스 생성 지원
• 다음과 같은 페이지를 제공
  
  
  

Spring Boot에서 swagger 적용하기

의존성 추가하기

• springdoc 다음에서 버전등을 확인할 수 있다.
• build.gradle

dependencies {
	implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.4.0'
}

swagger 버전에 따른 URL

• 2.x.x 버전: localhost:8080/swagger-ui.html
• 3.x.x 버전: localhost:8080/swagger-ui/index.html
• **우리는 3.x.x 버전을 사용중이다.

화면 확인하기

다음과 같은 화면이 나오면 제대로 적용한 것이다.

Swagger 설정하기

• application.properties

# springdoc-openapi
springdoc.swagger-ui.path=/api-docs

• 간단하게 path만 설정하였다.
• 이제 localhost:8080/api-docs를 통해 접근 가능하다.
• SwaggerConfig.java

package com.chan.ssb;

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("API Test") // API의 제목
                .description("Let's practice Swagger UI") // API에 대한 설명
                .version("1.0.0"); // API의 버전
    }
}

다음과 같이 적용할 수 있다.