Skip to content

Commit 9adc196

Browse files
bnasslahsenbnasslahsen
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

+26-1
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

+26
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.

‎docs/v2/faq.html

+26-1
Original file line numberDiff line numberDiff line change
@@ -1879,12 +1879,37 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
18791879
</tbody>
18801880
</table>
18811881
</div>
1882+
<div class="sect2">
1883+
<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>
1884+
<div class="paragraph">
1885+
<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>
1886+
</div>
1887+
<div class="listingblock">
1888+
<div class="content">
1889+
<pre class="highlight"><code class="language-java" data-lang="java"> converters.add(new ByteArrayHttpMessageConverter());
1890+
converters.add(new MappingJackson2HttpMessageConverter(jacksonBuilder.build()));
1891+
</code></pre>
1892+
</div>
1893+
</div>
1894+
<div class="admonitionblock note">
1895+
<table>
1896+
<tr>
1897+
<td class="icon">
1898+
<i class="fa icon-note" title="Note"></i>
1899+
</td>
1900+
<td class="content">
1901+
Order is very important, when registering <code>HttpMessageConverters</code>.
1902+
</td>
1903+
</tr>
1904+
</table>
1905+
</div>
1906+
</div>
18821907
</div>
18831908
</div>
18841909
</div>
18851910
<div id="footer">
18861911
<div id="footer-text">
1887-
Last updated 2023-04-02 01:12:58 +0200
1912+
Last updated 2023-05-01 19:38:39 +0200
18881913
</div>
18891914
</div>
18901915
</div>

‎docs/v2/fonts/FontAwesome.otf

100644100755
File mode changed.

‎docs/v2/fonts/fontawesome-webfont.eot

100644100755
File mode changed.

‎docs/v2/fonts/fontawesome-webfont.svg

100644100755
File mode changed.

‎docs/v2/fonts/fontawesome-webfont.ttf

100644100755
File mode changed.

‎docs/v2/fonts/fontawesome-webfont.woff

100644100755
File mode changed.

‎docs/v2/fonts/fontawesome-webfont.woff2

100644100755
File mode changed.

‎docs/v2/index.html

+26
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,7 @@ <h1>springdoc-openapi v2.1.0</h1>
183183
<li><a href="#customizing-swagger-static-resources">13.76. Customizing swagger static resources</a></li>
184184
<li><a href="#is-graalvm-supported">13.77. Is GraalVM supported ?</a></li>
185185
<li><a href="#what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">13.78. What is the compatibility matrix of <code>springdoc-openapi</code> with <code>spring-boot</code> ?</a></li>
186+
<li><a href="#why-am-i-getting-an-error-swagger-ui-unable-to-render-definition-when-overriding-the-default-spring-registered-httpmessageconverter">13.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>
186187
</ul>
187188
</li>
188189
</ul>
@@ -4466,6 +4467,31 @@ <h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">
44664467
</tr>
44674468
</tbody>
44684469
</table>
4470+
</div>
4471+
<div class="sect2">
4472+
<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>13.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>
4473+
<div class="paragraph">
4474+
<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>
4475+
</div>
4476+
<div class="listingblock">
4477+
<div class="content">
4478+
<pre class="highlight"><code class="language-java" data-lang="java"> converters.add(new ByteArrayHttpMessageConverter());
4479+
converters.add(new MappingJackson2HttpMessageConverter(jacksonBuilder.build()));
4480+
</code></pre>
4481+
</div>
4482+
</div>
4483+
<div class="admonitionblock note">
4484+
<table>
4485+
<tr>
4486+
<td class="icon">
4487+
<i class="fa icon-note" title="Note"></i>
4488+
</td>
4489+
<td class="content">
4490+
Order is very important, when registering <code>HttpMessageConverters</code>.
4491+
</td>
4492+
</tr>
4493+
</table>
4494+
</div>
44694495
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
44704496
crossorigin="anonymous"></script>
44714497
<!-- HEADER2 -->

‎src/docs/asciidoc/faq.adoc

+11-1
Original file line numberDiff line numberDiff line change
@@ -1017,4 +1017,14 @@ More precisely, this the exhaustive list of spring-boot versions against which `
10171017
|`2.2.x`, `1.5.x` | `1.2.1`+
10181018
|`2.0.x`, `1.5.x` | `1.0.0`+
10191019

1020-
|===
1020+
|===
1021+
1022+
=== Why am i getting an error: `Swagger UI unable to render definition`, when overriding the default spring registered `HttpMessageConverter`?
1023+
When overriding the default spring-boot registered `HttpMessageConverter`, you should have `ByteArrayHttpMessageConverter` registered as well to have proper `springdoc-openapi` support.
1024+
1025+
[source,java]
1026+
----
1027+
converters.add(new ByteArrayHttpMessageConverter());
1028+
converters.add(new MappingJackson2HttpMessageConverter(jacksonBuilder.build()));
1029+
----
1030+
NOTE: Order is very important, when registering `HttpMessageConverters`.

‎src/docs/asciidoc/sitemap.xml

+75-15
Original file line numberDiff line numberDiff line change
@@ -2,62 +2,122 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://springdoc.org/</loc>
5-
<lastmod>2022-10-23</lastmod>
5+
<lastmod>2022-11-24</lastmod>
66
</url>
77
<url>
88
<loc>https://springdoc.org/index.html</loc>
9-
<lastmod>2022-10-23</lastmod>
9+
<lastmod>2022-11-24</lastmod>
1010
</url>
1111
<url>
1212
<loc>https://springdoc.org/core-properties.html</loc>
13-
<lastmod>2022-10-23</lastmod>
13+
<lastmod>2022-11-24</lastmod>
1414
</url>
1515
<url>
1616
<loc>https://springdoc.org/demos.html</loc>
17-
<lastmod>2022-10-23</lastmod>
17+
<lastmod>2022-11-24</lastmod>
1818
</url>
1919
<url>
2020
<loc>https://springdoc.org/faq.html</loc>
21-
<lastmod>2022-10-23</lastmod>
21+
<lastmod>2022-11-24</lastmod>
2222
</url>
2323
<url>
2424
<loc>https://springdoc.org/features.html</loc>
25-
<lastmod>2022-10-23</lastmod>
25+
<lastmod>2022-11-24</lastmod>
2626
</url>
2727
<url>
2828
<loc>https://springdoc.org/getting-started.html</loc>
29-
<lastmod>2022-10-23</lastmod>
29+
<lastmod>2022-11-24</lastmod>
3030
</url>
3131
<url>
3232
<loc>https://springdoc.org/intro.html</loc>
33-
<lastmod>2022-10-23</lastmod>
33+
<lastmod>2022-11-24</lastmod>
3434
</url>
3535
<url>
3636
<loc>https://springdoc.org/migrating-from-springfox.html</loc>
37-
<lastmod>2022-10-23</lastmod>
37+
<lastmod>2022-11-24</lastmod>
3838
</url>
3939
<url>
4040
<loc>https://springdoc.org/modules.html</loc>
41-
<lastmod>2022-10-23</lastmod>
41+
<lastmod>2022-11-24</lastmod>
4242
</url>
4343
<url>
4444
<loc>https://springdoc.org/other-resources.html</loc>
45-
<lastmod>2022-10-23</lastmod>
45+
<lastmod>2022-11-24</lastmod>
4646
</url>
4747
<url>
4848
<loc>https://springdoc.org/plugins.html</loc>
49-
<lastmod>2022-10-23</lastmod>
49+
<lastmod>2022-11-24</lastmod>
5050
</url>
5151
<url>
5252
<loc>https://springdoc.org/properties.html</loc>
53-
<lastmod>2022-10-23</lastmod>
53+
<lastmod>2022-11-24</lastmod>
5454
</url>
5555
<url>
5656
<loc>https://springdoc.org/ui-properties.html</loc>
57-
<lastmod>2022-10-23</lastmod>
57+
<lastmod>2022-11-24</lastmod>
5858
</url>
5959
<url>
6060
<loc>https://springdoc.org/thanks.html</loc>
61-
<lastmod>2022-10-23</lastmod>
61+
<lastmod>2022-11-24</lastmod>
62+
</url>
63+
<url>
64+
<loc>https://springdoc.org/v2</loc>
65+
<lastmod>2022-11-24</lastmod>
66+
</url>
67+
<url>
68+
<loc>https://springdoc.org/v2/index.html</loc>
69+
<lastmod>2022-11-24</lastmod>
70+
</url>
71+
<url>
72+
<loc>https://springdoc.org/v2/core-properties.html</loc>
73+
<lastmod>2022-11-24</lastmod>
74+
</url>
75+
<url>
76+
<loc>https://springdoc.org/v2/demos.html</loc>
77+
<lastmod>2022-11-24</lastmod>
78+
</url>
79+
<url>
80+
<loc>https://springdoc.org/v2/faq.html</loc>
81+
<lastmod>2022-11-24</lastmod>
82+
</url>
83+
<url>
84+
<loc>https://springdoc.org/v2/features.html</loc>
85+
<lastmod>2022-11-24</lastmod>
86+
</url>
87+
<url>
88+
<loc>https://springdoc.org/v2/getting-started.html</loc>
89+
<lastmod>2022-11-24</lastmod>
90+
</url>
91+
<url>
92+
<loc>https://springdoc.org/v2/intro.html</loc>
93+
<lastmod>2022-11-24</lastmod>
94+
</url>
95+
<url>
96+
<loc>https://springdoc.org/v2/migrating-from-springfox.html</loc>
97+
<lastmod>2022-11-24</lastmod>
98+
</url>
99+
<url>
100+
<loc>https://springdoc.org/v2/modules.html</loc>
101+
<lastmod>2022-11-24</lastmod>
102+
</url>
103+
<url>
104+
<loc>https://springdoc.org/v2/other-resources.html</loc>
105+
<lastmod>2022-11-24</lastmod>
106+
</url>
107+
<url>
108+
<loc>https://springdoc.org/v2/plugins.html</loc>
109+
<lastmod>2022-11-24</lastmod>
110+
</url>
111+
<url>
112+
<loc>https://springdoc.org/v2/properties.html</loc>
113+
<lastmod>2022-11-24</lastmod>
114+
</url>
115+
<url>
116+
<loc>https://springdoc.org/v2/ui-properties.html</loc>
117+
<lastmod>2022-11-24</lastmod>
118+
</url>
119+
<url>
120+
<loc>https://springdoc.org/v2/thanks.html</loc>
121+
<lastmod>2022-11-24</lastmod>
62122
</url>
63123
</urlset>

‎src/docs/asciidoc/v2/faq.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -947,3 +947,14 @@ More precisely, this the exhaustive list of spring-boot versions against which `
947947
|`2.0.x`, `1.5.x` | `1.0.0`+
948948

949949
|===
950+
951+
952+
=== Why am i getting an error: `Swagger UI unable to render definition`, when overriding the default spring registered `HttpMessageConverter`?
953+
When overriding the default spring-boot registered `HttpMessageConverter`, you should have `ByteArrayHttpMessageConverter` registered as well to have proper `springdoc-openapi` support.
954+
955+
[source,java]
956+
----
957+
converters.add(new ByteArrayHttpMessageConverter());
958+
converters.add(new MappingJackson2HttpMessageConverter(jacksonBuilder.build()));
959+
----
960+
NOTE: Order is very important, when registering `HttpMessageConverters`.

0 commit comments

Comments
 (0)