<SpringBoot> Swagger 적용해보기

# SpringBoot 프로젝트에 Swagger 스웨거 를 적용해보자.

- 현재 예제로 개발하고 있는 게시판 프로젝트에 적용을 해보자.

1. 일단 build.gradle에 라이브러리를 추가한다.

일단 Swagger3.0은 스프링 부트 버전 때문인지 적용하면 에러가 발생, 트러블 슈팅 보다는 다른 라이브러리를 추가하는게 낫겠다 싶어서 open-api 라이브러리를 추가함.

// Swagger
implementation 'org.springdoc:springdoc-openapi-ui:1.6.6'

2. SwaggerConfig.java 파일을 생성하고 아래의 코드를 작성해준다.

- 기본적인 설정 코드인거 같고, 

package com.example.firstproject;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springdoc.core.GroupedOpenApi;
import org.springframework.context.annotation.Bean;

public class SwaggerConfig {
    @Bean
    public GroupedOpenApi publicApi() {
        return GroupedOpenApi.builder()
                .group("예제 게시판 Swagger")
                .pathsToMatch("/api/**")
                .build();
    }

    @Bean
    public OpenAPI springShopOpenAPI() {
        return new OpenAPI()
                .info(new Info().title("예제 게시판 API")
                        .description("예제 게시판 API 명세서입니다.")
                        .version("v0.0.1"));
    }
}

- 기본적으로 Swagger 는 @RestController 어노테이션이 붙은 데이터만 가져오는거 같다.

일단 api 패키지에있는 데이터는 다 가져오는거 같다.

3. 설정은 끝났고, 실행 화면은 아래와 같다.

- Swagger를 잘 활용하면 API 테스트 및 문서화 등 작업을 편리하게 할 수 있을거 같긴 하다.

좀 더 써봐야겠다.

 

- 끝 -