[Spring] 스웨거(Swagger) 렌더링이 안 될 때(Unable to render this definition) 체크해볼 것 - messageConverter

배경아래 스크린샷의 메시지와 함께 스웨거가 렌더링되지 않는 현상이 발생했습니다. 내용만 보면 간단한 문제같아 보입니다. OpenAPI 설정에 필요한 버전 정보를 명시해주면 되는 것처럼 보이기 때문입니다. 취합한 정보를 바탕으로 여러 가지 방법을 적용해봤습니다. 그 과정에서 application.properties에 설정값도 넣어보고,  @OpenAPIDefinition 어노테이션을 통해 문서 정보를 기입해보기도 하고, 별도의 SwaggerConfig 클래스를 생성하여 설정을 주입해보기도 하고, 스프링부트 버전과 springdoc의 버전을 변경해보기도 했지만 문제를 해결할 수는 없었습니다. 문제의 원인1. 파싱 불가능한 형태로 openapi 명세가 리턴됨스웨거에서는 왜 버전 필드를  읽어오지 못했을까요?저..

• format_list_bulleted 개발지식/Spring
• · 2025. 4. 8.
• textsms

[Swagger] Token "Component" does not exist 에러 대처 방법

스웨거 공식 문서에 기입된 스펙에 맞게 component를 작성한 후, 재사용되는 파라미터들(검색 창의 검색 파라미터)을 별도 문서에 정의하여 component별로 참조해서 사용하고자 하였다. 그러나 글 제목과 같은 에러메시지가 출력되어 원인을 검색해보니 다양한 이유와 해결방법이 제시되어있었는데, 나의 경우에는 순환참조로 인한 오류가 원인으로 드러났다(제목의 Component는 오류가 발생한 component의 이름을 의미한다). 내가 관리하는 스웨거의 구조에서는 경로관리파일, 컴포넌트(파라미터, 스키마 등) 정의 파일, 경로별/메서드별 정의(req 메서드, res 양식 등) 파일이 각각 다른 파일로 분리되어 있었는데 알고보니 컴포넌트 정의파일과 경로 파일이 서로를 참조하고 있었던 것이다. 문제의 원인이..

• format_list_bulleted 개발지식/Web
• · 2023. 1. 16.
• textsms