[Swagger] 스웨거 오류: Unable to render this definitionThe provided definition does not specify a valid version field.

2024. 12. 3. 14:00·Error Log
목차
  1. 기술스택
  2. 개요
  3. 해결 방법

기술스택

  • Spring Boot 3.4.0
  • JDK 17
  • gradle

 

 

개요

스프링 부트에 Swagger의존성 추가 후 실행시키니 다음과 같은 오류가 발생했습니다.

Swagger 오류

Unable to render this definition
The provided definition does not specify a valid version field.
Please indicate a valid Swagger or OpenAPI version field. Supported version fields are swagger: "2.0" and those that match openapi: 3.x.y (for example, openapi: 3.1.0).

 

다른 블로그를 아무리 찾아서 따라해봐도 해결이 안되는 상황이였습니다.

 

 

해결 방법

https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui

혹시나 하고 의존성을 확인 후 build.gralde에 Swagger 의존성을 최신 버전으로 수정했습니다.

// swagger
// implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2' // 구버전
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.7.0'

 

그리고 Configuration 파일을 작성하면 됩니다. 

@Configuration
public class SwaggerConfig {
@Bean
public GroupedOpenApi boardGroupedOpenApi() {
return GroupedOpenApi
.builder()
.group("board") // group 설정 (API들을 그룹화시켜 그룹에 속한 API들만 확인할 수 있도록 도와줌)
.pathsToMatch("/board/**") // group에 포함될 API endpoint 경로
.addOpenApiCustomizer(openApi ->
openApi.setInfo(new Info()
.title("board api") // API 제목
.description("게시판 업무 처리를 위한 API") // API 설명
.version("1.0.0") // API 버전
)
)
.build();
}
}

 

마지막으로 아래의 링크로 접속하면됩니다.

http://localhost:8080/swagger-ui/index.html

동작 확인

잘 동작하는 것을 확인하실 수 있습니다. 

'Error Log' 카테고리의 다른 글

Spring Boot + Nginx 환경에서 redirect 시 HTTPS가 HTTP로 변경되는 문제 해결하기  (0) 2025.04.21
[Querydsl] No sources given 에러  (0) 2024.12.01
  1. 기술스택
  2. 개요
  3. 해결 방법
'Error Log' 카테고리의 다른 글
  • Spring Boot + Nginx 환경에서 redirect 시 HTTPS가 HTTP로 변경되는 문제 해결하기
  • [Querydsl] No sources given 에러
Economy98
Economy98
공부하고 기록하기
  • Economy98
    Economy_Dev
    Economy98
  • 전체
    오늘
    어제
    • 분류 전체보기 (77)
      • Spring Framework (12)
      • BOJ, Programmers (22)
      • Java (6)
      • JDBC (6)
      • JPA (9)
      • Spring Transaction (3)
      • Algorithm (1)
      • Web (5)
      • Projects (2)
        • 쇼핑몰 프로젝트 (0)
        • 열람실 & 도서관 프로젝트 (2)
      • Network (2)
      • 나의 공부방 (5)
      • 끄적끄적 (1)
      • Error Log (3)
      • CS (0)
  • 블로그 메뉴

    • 홈
    • 태그
    • 방명록
    • Github
  • 링크

    • Github
  • 공지사항

  • 인기 글

  • 태그

    백준
    스프링부트
    예외 처리
    Spring
    백준 풀이
    정렬
    다이나믹 프로그래밍
    백준 자바 풀이
    JPA
    propagation
    그리디 알고리즘
    트랜잭션
    restful api
    브루트포스 알고리즘
    스프링
    자바 문제 풀이
    자바 문제
    자바
    java
    jdbc
  • 최근 댓글

  • 최근 글

  • hELLO· Designed By정상우.v4.10.1
Economy98
[Swagger] 스웨거 오류: Unable to render this definitionThe provided definition does not specify a valid version field.

개인정보

  • 티스토리 홈
  • 포럼
  • 로그인
상단으로

티스토리툴바

단축키

내 블로그

내 블로그 - 관리자 홈 전환
Q
Q
새 글 쓰기
W
W

블로그 게시글

글 수정 (권한 있는 경우)
E
E
댓글 영역으로 이동
C
C

모든 영역

이 페이지의 URL 복사
S
S
맨 위로 이동
T
T
티스토리 홈 이동
H
H
단축키 안내
Shift + /
⇧ + /

* 단축키는 한글/영문 대소문자로 이용 가능하며, 티스토리 기본 도메인에서만 동작합니다.