Swagger 500 오류 해결 방법

상황 정리

스프링부트로 RESTful 웹 서비스를 만들고, OpenAPI 3를 이용하여 API를 문서화 하는

작업을 하던 도중에 아래 이미지 처럼 500 에러가 나왔습니다.

 

---

오류 해결

build.gradle 파일의 dependencies에

 

implementation group: 'org.springdoc', name: 'springdoc-openapi-starter-webmvc-ui', version: '2.0.2'

 

해당 의존성을 추가하고,

 

아래의 OpenApiConfig 클래스를 생성한 후,

package com.packt.cardatabase;

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 OpenApiConfig {
    @Bean
    public OpenAPI carDatabaseOpenAPI() {
        return new OpenAPI().info(new Info().title("Car REST API").description("My car stock").version("1.0"));
    }
}

 

application.properties에 아래의 코드를 추가했는데,

springdoc.api-docs.path=/api-docs
springdoc.swagger-ui.path=/swagger-ui.html
springdoc.swagger-ui.enabled=true

 

500 에러가 나와서 찾아보니,

 

springframework.boot의 버전이 맞지 않아서 안되는 문제 였습니다.

 

그래서 아래 이미지 처럼 버전을 변경하니 정상적으로 동작하였습니다.