우선 Swagger는 API 문서를 자동으로 생성해주는 도구로, 개발 중 REST API를 시각화하고 테스트할 때 유용합니다.

build.gradle

implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.4'// Swagger 

을 추가해준다.

SwaggerConfig.java

package website.server.Global.Config;

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

@Configuration
public class SwaggerConfig {

   @Bean
   public OpenAPI customOpenAPI() {
       return new OpenAPI()
               .info(new Info()
                       .version("v1.0.0")                // 버전 기록
                       .title("website project")                // API 명세서 제목
                       .description("웹 사이트 개발 프로젝트"));   // 상세

   }
}
profile
내가 있는 그 조직에서 가장 성실하기만 하자

0개의 댓글