Spring Swagger(springdoc-openapi) Unable to render this definition 오류

Spring 에서 문서화를 추가하고자 Swagger(Springdoc-openapi)를 추가하려고 하는데, 아래와 같은 문구가 나옵니다.

 

Unable to render this definition ...

 

 

 

실제 api-docs URL로 접근해보면, 아래와 같이 메시지가 정상적으로 컨버터가 안되어 나오는 듯 한 현상이 발생합니다.

 

 

 

현재 프로젝트에서는 MessageConverter 를 Custom하여 사용하고 있고, 대략적으로 아래와 같이 사용중입니다.

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        super.configureMessageConverters(converters);
        StringHttpMessageConverter converter = new StringHttpMessageConverter(StandardCharsets.UTF_8);
        converter.setWriteAcceptCharset(false);
        converter.setSupportedMediaTypes(Arrays.asList(new MediaType("text", "plain", StandardCharsets.UTF_8)));

        converters.add(converter);
        converters.add(new MappingJackson2HttpMessageConverter());
    }

 

 

 

OpenAPI 공식 문서에 보면, 위와 동일한 문제가 발생했을 때 해결 방법에 대해 설명하고 있습니다.

https://springdoc.org/#why-am-i-getting-an-error-swagger-ui-unable-to-render-definition-when-overriding-the-default-spring-registered-httpmessageconverter

OpenAPI 3 Library for spring-boot

ByteArrayHttpMessageConverter를 등록하라고 나오는데요, Note에는 등록 순서 또한 중요하다고 합니다.

 

 

 

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        super.configureMessageConverters(converters);
        StringHttpMessageConverter converter = new StringHttpMessageConverter(StandardCharsets.UTF_8);
        converter.setWriteAcceptCharset(false);
        converter.setSupportedMediaTypes(Arrays.asList(new MediaType("text", "plain", StandardCharsets.UTF_8)));

        converters.add(converter);
        converters.add(new ByteArrayHttpMessageConverter()); // 추가
        converters.add(new MappingJackson2HttpMessageConverter());
    }

위와 같이 ByteArrayHttpMessageConverter() 를 MappingJackson2HttpMessageConverter() 전에 등록을 하면 정상적으로 호출이 되는데, 순서를 반대로 하면 동일하게 Unable to render ... 오류가 발생합니다.