SpringBoot 3버전 Swagger 적용하기

Swagger 설명 및 설정방법

Spring Boot 3에 Swagger 적용하기(springdoc-openapi)

 

Spring swagger 3 사용방법(springdoc-openapi-ui)

• 스웨거란 서버로 요청되는 API 리스트를 HTML 화면으로 문서화하여 테스트할 수 있는 라이브러리
• 서버가 가동되면서 @RestController를 읽어 API 분석하여 HTML 문서 작성함

@Configuration

• 어노테이션 기반의 환경 구성을 돕는 어노테이션
• IoC Container에게 해당 클래스를 Bean 구성 Class임을 알려줌

@Bean

• 개발자가 직접 제어가 불가능한 외부 라이브러리 등을 Bean으로 만들 경우에 사용

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.1.6'
    id 'io.spring.dependency-management' version '1.1.4'
}

group = 'com.example'
// 버전
version = '1.0.0'


dependencies {
// <https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui>
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0'
}

config폴더에 SwaggerConfigration 생성

package com.example.testproject.config;

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 SwaggerConfigration {

    @Bean
    public OpenAPI openAPI(){
        return new OpenAPI()
                .info(new Info()
                .title("test-api!")
                .description("테스트용입니다")
                .version("1.0.0"));
    }

}

 

스웨거 적용된건지 확인하기

http://localhost:적용한포트번호/swagger-ui/index.html로 접속, 보통 8080