Skip to content

Commit b1273fd

Browse files
bnasslahsenbnasslahsen
committed
release 2.8.13
1 parent 2090c03 commit b1273fd

File tree

17 files changed

+541
-205
lines changed

17 files changed

+541
-205
lines changed

‎docs/demos.html‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,16 @@ <h3 id="_springdoc_applications_demos"><a class="anchor" href="#_springdoc_appli
3737
<div class="ulist">
3838
<ul>
3939
<li>
40-
<p><a href="https://demos.springdoc.org/demo-spring-boot-3-webmvc" target="_blank" rel="noopener">Demo Spring Boot 3 Web MVC with OpenAPI 3</a></p>
40+
<p><a href="https://demos.springdoc.org/demo-spring-boot-3-webmvc" target="_blank" rel="noopener">Demo Spring Boot 3 Web MVC with OpenAPI 3 and Swagger-UI</a></p>
4141
</li>
4242
<li>
43-
<p><a href="https://demos.springdoc.org/demo-spring-boot-3-webflux/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 3 WebFlux with OpenAPI 3</a></p>
43+
<p><a href="https://demos.springdoc.org/demo-spring-boot-3-webflux/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 3 WebFlux with OpenAPI 3 and Swagger-UI</a></p>
44+
</li>
45+
<li>
46+
<p><a href="https://demos.springdoc.org/demo-spring-boot-webmvc-scalar/scalar" target="_blank" rel="noopener">Demo Spring Boot 3 Web MVC with OpenAPI 3 and Scalar</a></p>
47+
</li>
48+
<li>
49+
<p><a href="https://demos.springdoc.org/demo-spring-boot-webflux-scalar/scalar" target="_blank" rel="noopener">Demo Spring Boot 3 WebFlux with OpenAPI 3 and Scalar</a></p>
4450
</li>
4551
<li>
4652
<p><a href="https://demos.springdoc.org/demo-spring-boot-3-webflux-functional/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 3 WebFlux with Functional endpoints OpenAPI 3</a></p>
@@ -91,7 +97,7 @@ <h3 id="_source_code_of_the_demo_applications"><a class="anchor" href="#_source_
9197
</div>
9298
<div id="footer">
9399
<div id="footer-text">
94-
Last updated 2025-08-22 21:24:52 +0200
100+
Last updated 2025-09-07 15:07:54 +0200
95101
</div>
96102
</div>
97103
</div>

‎docs/faq.html‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -337,14 +337,8 @@ <h3 id="_how_can_i_ignore_authenticationprincipal_parameter_from_spring_security
337337
<p><code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.</p>
338338
</li>
339339
<li>
340-
<p>OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.</p>
341-
</li>
342-
<li>
343340
<p>OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.</p>
344341
</li>
345-
<li>
346-
<p>OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
347-
</li>
348342
</ul>
349343
</div>
350344
</li>
@@ -2010,7 +2004,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
20102004
<p><code>springdoc-openapi 2.x</code> is compatible with <code>spring-boot 3</code>.</p>
20112005
</div>
20122006
<div class="paragraph">
2013-
<p>In general, <strong>you should only pick the last stable version as per today 2.8.12.</strong></p>
2007+
<p>In general, <strong>you should only pick the last stable version as per today 2.8.13.</strong></p>
20142008
</div>
20152009
<div class="paragraph">
20162010
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>
@@ -2129,7 +2123,7 @@ <h3 id="_some_parameters_are_not_generated_in_the_resulting_openapi_spec"><a cla
21292123
</div>
21302124
<div id="footer">
21312125
<div id="footer-text">
2132-
Last updated 2025-08-20 18:06:19 +0200
2126+
Last updated 2025-09-07 14:59:24 +0200
21332127
</div>
21342128
</div>
21352129
</div>

‎docs/getting-started.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
4040
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
4141
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
4242
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
43-
&lt;version&gt;2.8.12&lt;/version&gt;
43+
&lt;version&gt;2.8.13&lt;/version&gt;
4444
&lt;/dependency&gt;</code></pre>
4545
</div>
4646
</div>

‎docs/index.html‎

Lines changed: 119 additions & 54 deletions
Large diffs are not rendered by default.

‎docs/migrating-from-springfox.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
4444
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
4545
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
4646
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
47-
&lt;version&gt;2.8.12&lt;/version&gt;
47+
&lt;version&gt;2.8.13&lt;/version&gt;
4848
&lt;/dependency&gt;</code></pre>
4949
</div>
5050
</div>

‎docs/modules.html‎

Lines changed: 87 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ <h3 id="_spring_webmvc_support"><a class="anchor" href="#_spring_webmvc_support"
7373
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
7474
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
7575
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-api&lt;/artifactId&gt;
76-
&lt;version&gt;2.8.12&lt;/version&gt;
76+
&lt;version&gt;2.8.13&lt;/version&gt;
7777
&lt;/dependency&gt;</code></pre>
7878
</div>
7979
</div>
@@ -125,7 +125,88 @@ <h3 id="_spring_webflux_support"><a class="anchor" href="#_spring_webflux_suppor
125125
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
126126
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
127127
&lt;artifactId&gt;springdoc-openapi-starter-webflux-api&lt;/artifactId&gt;
128-
&lt;version&gt;2.8.12&lt;/version&gt;
128+
&lt;version&gt;2.8.13&lt;/version&gt;
129+
&lt;/dependency&gt;</code></pre>
130+
</div>
131+
</div>
132+
</div>
133+
<div class="sect2">
134+
<h3 id="_swagger_ui_support"><a class="anchor" href="#_swagger_ui_support"></a>Swagger-UI support</h3>
135+
<div class="paragraph">
136+
<p><a href="https://swagger.io/tools/swagger-ui/">Swagger UI</a> allows anyone — be it your development team or your end consumers — to visualize and interact with the API’s resources without having any of the implementation logic in place. It’s automatically generated from your OpenAPI (formerly known as Swagger) Specification, with the visual documentation making it easy for back end implementation and client side consumption.</p>
137+
</div>
138+
<div class="ulist">
139+
<ul>
140+
<li>
141+
<p>If your project is using <code>spring-boot-starter-web</code> and you need the access to the swagger-ui, add the following dependency:</p>
142+
</li>
143+
</ul>
144+
</div>
145+
<div class="listingblock">
146+
<div class="content">
147+
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
148+
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
149+
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
150+
&lt;version&gt;2.8.13&lt;/version&gt;
151+
&lt;/dependency&gt;</code></pre>
152+
</div>
153+
</div>
154+
<div class="ulist">
155+
<ul>
156+
<li>
157+
<p>If your project is using <code>spring-boot-starter-webflux</code> and you need the access to the swagger-ui, add the following dependency:</p>
158+
</li>
159+
</ul>
160+
</div>
161+
<div class="listingblock">
162+
<div class="content">
163+
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
164+
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
165+
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
166+
&lt;version&gt;2.8.13&lt;/version&gt;
167+
&lt;/dependency&gt;</code></pre>
168+
</div>
169+
</div>
170+
</div>
171+
<div class="sect2">
172+
<h3 id="_scalar_support"><a class="anchor" href="#_scalar_support"></a>Scalar support</h3>
173+
<div class="paragraph">
174+
<p><a href="https://swagger.io/tools/swagger-ui/">Scalar</a> Scalar is an open-source API platform, designed for creating beautiful, interactive API documentation and providing a built-in REST API client, with first-class support for OpenAPI (formerly Swagger) specifications.
175+
It’s particularly aimed at improving the developer experience when exploring APIs.</p>
176+
</div>
177+
<div class="paragraph">
178+
<p><code>springdoc-openapi</code> extends <code>Scalar</code> configuration to make it compatible with Spring Boot applications.
179+
You can rely on native Scalar configuration properties, using the prefix <code>scalar</code>, as explained in the <a href="https://guides.scalar.com/scalar/scalar-api-references/integrations/spring-boot#configuration-properties">Scalar documentation</a>.</p>
180+
</div>
181+
<div class="ulist">
182+
<ul>
183+
<li>
184+
<p>If your project is using <code>spring-boot-starter-web</code> and you need the access to the swagger-ui, add the following dependency:</p>
185+
</li>
186+
</ul>
187+
</div>
188+
<div class="listingblock">
189+
<div class="content">
190+
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
191+
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
192+
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-scalar&lt;/artifactId&gt;
193+
&lt;version&gt;2.8.13&lt;/version&gt;
194+
&lt;/dependency&gt;</code></pre>
195+
</div>
196+
</div>
197+
<div class="ulist">
198+
<ul>
199+
<li>
200+
<p>If your project is using <code>spring-boot-starter-webflux</code> and you need the access to the swagger-ui, add the following dependency:</p>
201+
</li>
202+
</ul>
203+
</div>
204+
<div class="listingblock">
205+
<div class="content">
206+
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
207+
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
208+
&lt;artifactId&gt;springdoc-openapi-starter-webflux-scalar&lt;/artifactId&gt;
209+
&lt;version&gt;2.8.13&lt;/version&gt;
129210
&lt;/dependency&gt;</code></pre>
130211
</div>
131212
</div>
@@ -373,10 +454,10 @@ <h3 id="_spring_cloud_function_web_support"><a class="anchor" href="#_spring_clo
373454
<div class="ulist">
374455
<ul>
375456
<li>
376-
<p>If you are using <code>spring-web</code>, simply add the <code>springdoc-openapi-starter-webmvc-ui</code> dependency.</p>
457+
<p>If you are using <code>spring-web</code>, simply add the <code>springdoc-openapi-starter-webmvc-api</code> dependency.</p>
377458
</li>
378459
<li>
379-
<p>If you are using <code>spring-webflux</code>, simply add the <code>springdoc-openapi-starter-webflux-ui</code> dependency.</p>
460+
<p>If you are using <code>spring-webflux</code>, simply add the <code>springdoc-openapi-starter-webflux-api</code> dependency.</p>
380461
</li>
381462
</ul>
382463
</div>
@@ -469,14 +550,8 @@ <h3 id="_kotlin_support"><a class="anchor" href="#_kotlin_support"></a>Kotlin su
469550
<p><code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.</p>
470551
</li>
471552
<li>
472-
<p>OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.</p>
473-
</li>
474-
<li>
475553
<p>OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.</p>
476554
</li>
477-
<li>
478-
<p>OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
479-
</li>
480555
</ul>
481556
</div>
482557
<div class="admonitionblock note">
@@ -511,14 +586,8 @@ <h3 id="_groovy_support"><a class="anchor" href="#_groovy_support"></a>Groovy su
511586
<p><code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.</p>
512587
</li>
513588
<li>
514-
<p>OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.</p>
515-
</li>
516-
<li>
517589
<p>OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.</p>
518590
</li>
519-
<li>
520-
<p>OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
521-
</li>
522591
</ul>
523592
</div>
524593
</div>
@@ -549,14 +618,8 @@ <h3 id="_javadoc_support"><a class="anchor" href="#_javadoc_support"></a>Javadoc
549618
<p><code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.</p>
550619
</li>
551620
<li>
552-
<p>OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.</p>
553-
</li>
554-
<li>
555621
<p>OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.</p>
556622
</li>
557-
<li>
558-
<p>OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
559-
</li>
560623
</ul>
561624
</div>
562625
<div class="admonitionblock note">
@@ -627,7 +690,7 @@ <h3 id="_springdoc_openapi_bom"><a class="anchor" href="#_springdoc_openapi_bom"
627690
&lt;dependency&gt;
628691
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
629692
&lt;artifactId&gt;springdoc-openapi-bom&lt;/artifactId&gt;
630-
&lt;version&gt;2.8.12&lt;/version&gt;
693+
&lt;version&gt;2.8.13&lt;/version&gt;
631694
&lt;type&gt;pom&lt;/type&gt;
632695
&lt;scope&gt;import&lt;/scope&gt;
633696
&lt;/dependency&gt;
@@ -641,7 +704,7 @@ <h3 id="_springdoc_openapi_bom"><a class="anchor" href="#_springdoc_openapi_bom"
641704
</div>
642705
<div id="footer">
643706
<div id="footer-text">
644-
Last updated 2025-05-04 17:47:09 +0200
707+
Last updated 2025-09-07 15:03:47 +0200
645708
</div>
646709
</div>
647710
</div>

‎docs/v4/demos.html‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,12 @@ <h3 id="_springdoc_applications_demos"><a class="anchor" href="#_springdoc_appli
4343
<p><a href="https://demos1.springdoc.org/demo-spring-boot-webflux/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 4 WebFlux with OpenAPI 3</a></p>
4444
</li>
4545
<li>
46+
<p><a href="https://demos1.springdoc.org/demo-spring-boot-webmvc-scalar/scalar" target="_blank" rel="noopener">Demo Spring Boot 4 Web MVC with OpenAPI 3 and Scalar</a></p>
47+
</li>
48+
<li>
49+
<p><a href="https://demos1.springdoc.org/demo-spring-boot-webflux-scalar/scalar" target="_blank" rel="noopener">Demo Spring Boot 4 WebFlux with OpenAPI 3 and Scalar</a></p>
50+
</li>
51+
<li>
4652
<p><a href="https://demos1.springdoc.org/demo-spring-boot-webflux-functional/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 4 WebFlux with Functional endpoints OpenAPI 3</a></p>
4753
</li>
4854
<li>
@@ -91,7 +97,7 @@ <h3 id="_source_code_of_the_demo_applications"><a class="anchor" href="#_source_
9197
</div>
9298
<div id="footer">
9399
<div id="footer-text">
94-
Last updated 2025-08-22 21:04:37 +0200
100+
Last updated 2025-09-07 15:08:33 +0200
95101
</div>
96102
</div>
97103
</div>

‎docs/v4/faq.html‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -337,14 +337,8 @@ <h3 id="_how_can_i_ignore_authenticationprincipal_parameter_from_spring_security
337337
<p><code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.</p>
338338
</li>
339339
<li>
340-
<p>OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.</p>
341-
</li>
342-
<li>
343340
<p>OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.</p>
344341
</li>
345-
<li>
346-
<p>OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
347-
</li>
348342
</ul>
349343
</div>
350344
</li>
@@ -2081,7 +2075,7 @@ <h3 id="_some_parameters_are_not_generated_in_the_resulting_openapi_spec"><a cla
20812075
</div>
20822076
<div id="footer">
20832077
<div id="footer-text">
2084-
Last updated 2025-08-22 13:22:49 +0200
2078+
Last updated 2025-09-07 14:59:24 +0200
20852079
</div>
20862080
</div>
20872081
</div>

0 commit comments

Comments
 (0)