Skip to content

Commit 9adc196

Browse files
committed
For SpringDoc OpenAPI 1.6, Swagger UI unable to render definition. Fixes #52
1 parent 5d5c584 commit 9adc196

21 files changed

+201
-18
lines changed

docs/css/font-awesome.css

100644100755
File mode changed.

docs/faq.html

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1967,12 +1967,37 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
19671967
</tbody>
19681968
</table>
19691969
</div>
1970+
<div class="sect2">
1971+
<h3 id="_why_am_i_getting_an_error_swagger_ui_unable_to_render_definition_when_overriding_the_default_spring_registered_httpmessageconverter"><a class="anchor" href="#_why_am_i_getting_an_error_swagger_ui_unable_to_render_definition_when_overriding_the_default_spring_registered_httpmessageconverter"></a>Why am i getting an error: <code>Swagger UI unable to render definition</code>, when overriding the default spring registered <code>HttpMessageConverter</code>?</h3>
1972+
<div class="paragraph">
1973+
<p>When overriding the default spring-boot registered <code>HttpMessageConverter</code>, you should have <code>ByteArrayHttpMessageConverter</code> registered as well to have proper <code>springdoc-openapi</code> support.</p>
1974+
</div>
1975+
<div class="listingblock">
1976+
<div class="content">
1977+
<pre class="highlight"><code class="language-java" data-lang="java"> converters.add(new ByteArrayHttpMessageConverter());
1978+
converters.add(new MappingJackson2HttpMessageConverter(jacksonBuilder.build()));
1979+
</code></pre>
1980+
</div>
1981+
</div>
1982+
<div class="admonitionblock note">
1983+
<table>
1984+
<tr>
1985+
<td class="icon">
1986+
<i class="fa icon-note" title="Note"></i>
1987+
</td>
1988+
<td class="content">
1989+
Order is very important, when registering <code>HttpMessageConverters</code>.
1990+
</td>
1991+
</tr>
1992+
</table>
1993+
</div>
1994+
</div>
19701995
</div>
19711996
</div>
19721997
</div>
19731998
<div id="footer">
19741999
<div id="footer-text">
1975-
Last updated 2023-03-07 21:59:39 +0100
2000+
Last updated 2023-05-01 19:38:46 +0200
19762001
</div>
19772002
</div>
19782003
</div>

docs/fonts/FontAwesome.otf

100644100755
File mode changed.

docs/fonts/fontawesome-webfont.eot

100644100755
File mode changed.

docs/fonts/fontawesome-webfont.svg

100644100755
File mode changed.

docs/fonts/fontawesome-webfont.ttf

100644100755
File mode changed.

docs/fonts/fontawesome-webfont.woff

100644100755
File mode changed.

docs/fonts/fontawesome-webfont.woff2

100644100755
File mode changed.

docs/index.html

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,7 @@ <h1>springdoc-openapi v1.7.0</h1>
194194
<li><a href="#how-can-i-define-different-description-for-a-class-attribute-depending-on-usage">12.76. How can i define different description for a class attribute depending on usage?</a></li>
195195
<li><a href="#customizing-swagger-static-resources">12.77. Customizing swagger static resources</a></li>
196196
<li><a href="#what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">12.78. What is the compatibility matrix of <code>springdoc-openapi</code> with <code>spring-boot</code> ?</a></li>
197+
<li><a href="#why-am-i-getting-an-error-swagger-ui-unable-to-render-definition-when-overriding-the-default-spring-registered-httpmessageconverter">12.79. Why am i getting an error: <code>Swagger UI unable to render definition</code>, when overriding the default spring registered <code>HttpMessageConverter</code>?</a></li>
197198
</ul>
198199
</li>
199200
</ul>
@@ -4302,6 +4303,31 @@ <h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">
43024303
</tbody>
43034304
</table>
43044305
</div>
4306+
<div class="sect2">
4307+
<h3 id="why-am-i-getting-an-error-swagger-ui-unable-to-render-definition-when-overriding-the-default-spring-registered-httpmessageconverter"><a class="anchor" href="#why-am-i-getting-an-error-swagger-ui-unable-to-render-definition-when-overriding-the-default-spring-registered-httpmessageconverter"></a>12.79. Why am i getting an error: <code>Swagger UI unable to render definition</code>, when overriding the default spring registered <code>HttpMessageConverter</code>?</h3>
4308+
<div class="paragraph">
4309+
<p>When overriding the default spring-boot registered <code>HttpMessageConverter</code>, you should have <code>ByteArrayHttpMessageConverter</code> registered as well to have proper <code>springdoc-openapi</code> support.</p>
4310+
</div>
4311+
<div class="listingblock">
4312+
<div class="content">
4313+
<pre class="highlight"><code class="language-java" data-lang="java"> converters.add(new ByteArrayHttpMessageConverter());
4314+
converters.add(new MappingJackson2HttpMessageConverter(jacksonBuilder.build()));
4315+
</code></pre>
4316+
</div>
4317+
</div>
4318+
<div class="admonitionblock note">
4319+
<table>
4320+
<tr>
4321+
<td class="icon">
4322+
<i class="fa icon-note" title="Note"></i>
4323+
</td>
4324+
<td class="content">
4325+
Order is very important, when registering <code>HttpMessageConverters</code>.
4326+
</td>
4327+
</tr>
4328+
</table>
4329+
</div>
4330+
</div>
43054331
</div>
43064332
</div>
43074333
</div>

docs/v2/css/font-awesome.css

100644100755
File mode changed.

0 commit comments

Comments
 (0)