springdoc-openapi v2.6.0

링크 : https://springdoc.org/

• Spring Project에서 API Document화를 도와주는 라이브러리

1) Gradle 에 의존성 추가하기

...

dependencies {
    ...
    
    /* [ Swagger ] Spring Doc 2.6.0  */
    implementation group: 'org.springdoc', name: 'springdoc-openapi-starter-webmvc-ui', version: '2.6.0'

		...
}

...

2) Swagger Configure 설정하기

• @Configuration 어노테이션을 통해 설정
• title : 제목
• version : 버전 명시
• description : 설명

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 {

    private static final String TITLE = "백엔드 API 명세";
    private static final String VERSION = "0.1";
    private static final String DESCRIPTION = "블로그 프로젝트 백엔드 API 명세서입니다.";

    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title(TITLE)
                        .version(VERSION)
                        .description(DESCRIPTION));
    }
}

3) application.yaml 파일 설정하기

• api-docs : api에 대한 json 파일을 제공
• swagger-ui.html : Swagger GUI를 제공

...

springdoc:
  api-docs:
    path: /api-docs
  swagger-ui:
    path: /swagger-ui.html
    
...

4) 주소/swagger-ui 로 접속하여 Swagger GUI 페이지 확인