Skip to content

Commit 16bd636

Browse files
bnasslahsenbnasslahsen
committed
spring-boot-4 docs
1 parent 7c9e644 commit 16bd636

File tree

7 files changed

+99
-107
lines changed

7 files changed

+99
-107
lines changed

‎docs/migrating-from-springdoc-v1.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ <h2 id="migrating-from-springdoc-v1"><a class="anchor" href="#migrating-from-spr
222222
</div>
223223
<div id="footer">
224224
<div id="footer-text">
225-
Last updated 2024-10-06 14:24:00 +0200
225+
Last updated 2025-08-22 14:59:53 +0200
226226
</div>
227227
</div>
228228
</div>

‎docs/v4/index.html‎

Lines changed: 23 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -200,20 +200,6 @@ <h1>springdoc-openapi v3.0.0-M1</h1>
200200
<div id="content">
201201
<div id="preamble">
202202
<div class="sectionbody">
203-
<div class="admonitionblock important">
204-
<table>
205-
<tr>
206-
<td class="icon">
207-
<i class="fa icon-important" title="Important"></i>
208-
</td>
209-
<td class="content">
210-
<code>springdoc-openapi v1.8.0 </code> is the latest Open Source release supporting Spring Boot 2.x and 1.x.<br>
211-
An extended support for <a href="https://springdoc.org/v1"><strong>springdoc-openapi v1</strong></a> project is now available for organizations that need support beyond 2023.<br>
212-
For more details, feel free to reach out: <a href="mailto:sales@springdoc.org">sales@springdoc.org</a>
213-
</td>
214-
</tr>
215-
</table>
216-
</div>
217203
<div class="paragraph">
218204
<p><code>springdoc-openapi</code> is on <a href="https://opencollective.com/springdoc" target="_blank" rel="noopener">Open Collective</a>. If you ❤️ this project consider becoming a <a href="https://github.com/sponsors/springdoc" target="_blank" rel="noopener">sponsor</a>.</p>
219205
</div>
@@ -262,7 +248,7 @@ <h2 id="Introduction"><a class="anchor" href="#Introduction"></a>1. Introduction
262248
<p>OpenAPI 3</p>
263249
</li>
264250
<li>
265-
<p>Spring-boot v3 (Java 17 &amp; Jakarta EE 9)</p>
251+
<p>Spring-boot v4 (Java 17 &amp; Jakarta EE 9)</p>
266252
</li>
267253
<li>
268254
<p>JSR-303, specifically for @NotNull, @Min, @Max, and @Size.</p>
@@ -302,7 +288,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>2. Gettin
302288
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
303289
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
304290
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
305-
&lt;version&gt;2.8.10&lt;/version&gt;
291+
&lt;version&gt;3.0.0-M1&lt;/version&gt;
306292
&lt;/dependency&gt;</code></pre>
307293
</div>
308294
</div>
@@ -410,7 +396,7 @@ <h3 id="spring-webmvc-support"><a class="anchor" href="#spring-webmvc-support"><
410396
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
411397
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
412398
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-api&lt;/artifactId&gt;
413-
&lt;version&gt;2.8.10&lt;/version&gt;
399+
&lt;version&gt;3.0.0-M1&lt;/version&gt;
414400
&lt;/dependency&gt;</code></pre>
415401
</div>
416402
</div>
@@ -462,7 +448,7 @@ <h3 id="spring-webflux-support"><a class="anchor" href="#spring-webflux-support"
462448
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
463449
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
464450
&lt;artifactId&gt;springdoc-openapi-starter-webflux-api&lt;/artifactId&gt;
465-
&lt;version&gt;2.8.10&lt;/version&gt;
451+
&lt;version&gt;3.0.0-M1&lt;/version&gt;
466452
&lt;/dependency&gt;</code></pre>
467453
</div>
468454
</div>
@@ -787,7 +773,7 @@ <h3 id="spring-cloud-function-web-support"><a class="anchor" href="#spring-cloud
787773
<div class="ulist">
788774
<ul>
789775
<li>
790-
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/master/demo-spring-cloud-function" target="_blank" rel="noopener">Sample applications with Spring Cloud Function Web</a></p>
776+
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/4.x/demo-spring-cloud-function" target="_blank" rel="noopener">Sample applications with Spring Cloud Function Web</a></p>
791777
</li>
792778
</ul>
793779
</div>
@@ -964,7 +950,7 @@ <h3 id="springdoc-openapi-bom"><a class="anchor" href="#springdoc-openapi-bom"><
964950
&lt;dependency&gt;
965951
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
966952
&lt;artifactId&gt;springdoc-openapi-bom&lt;/artifactId&gt;
967-
&lt;version&gt;2.8.10&lt;/version&gt;
953+
&lt;version&gt;3.0.0-M1&lt;/version&gt;
968954
&lt;type&gt;pom&lt;/type&gt;
969955
&lt;scope&gt;import&lt;/scope&gt;
970956
&lt;/dependency&gt;
@@ -1111,7 +1097,7 @@ <h3 id="spring-webfluxwebmvc-fn-with-functional-endpoints"><a class="anchor" hre
11111097
<div class="ulist">
11121098
<ul>
11131099
<li>
1114-
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/master/demo-spring-boot-3-webflux-functional">Sample webflux application using functional DSL</a></p>
1100+
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/4.x/demo-spring-boot-webflux-functional">Sample webflux application using functional DSL</a></p>
11151101
</li>
11161102
</ul>
11171103
</div>
@@ -1248,7 +1234,7 @@ <h3 id="spring-webfluxwebmvc-fn-with-functional-endpoints"><a class="anchor" hre
12481234
<div class="ulist">
12491235
<ul>
12501236
<li>
1251-
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/master/demo-spring-boot-3-webflux-functional" target="_blank" rel="noopener">Sample application with Functional Endpoints documentation</a></p>
1237+
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/4.x/demo-spring-boot-webflux-functional" target="_blank" rel="noopener">Sample application with Functional Endpoints documentation</a></p>
12521238
</li>
12531239
</ul>
12541240
</div>
@@ -1997,22 +1983,22 @@ <h3 id="springdoc-applications-demos"><a class="anchor" href="#springdoc-applica
19971983
<div class="ulist">
19981984
<ul>
19991985
<li>
2000-
<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>
1986+
<p><a href="https://demos1.springdoc.org/demo-spring-boot-webmvc" target="_blank" rel="noopener">Demo Spring Boot 4 Web MVC with OpenAPI 3</a></p>
20011987
</li>
20021988
<li>
2003-
<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>
1989+
<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>
20041990
</li>
20051991
<li>
2006-
<p><a href="https://demos.springdoc.org/demo-spring-hateoas" target="_blank" rel="noopener">Demo Spring Boot 3 and Spring Hateoas with OpenAPI 3</a></p>
1992+
<p><a href="https://demos1.springdoc.org/demo-spring-hateoas" target="_blank" rel="noopener">Demo Spring Boot 4 and Spring Hateoas with OpenAPI 3</a></p>
20071993
</li>
20081994
<li>
2009-
<p><a href="https://demos.springdoc.org/spring-cloud-function-webmvc" target="_blank" rel="noopener">Demo Spring Boot 3 and Spring Cloud Function Web MVC</a></p>
1995+
<p><a href="https://demos1.springdoc.org/spring-cloud-function-webmvc" target="_blank" rel="noopener">Demo Spring Boot 4 and Spring Cloud Function Web MVC</a></p>
20101996
</li>
20111997
<li>
2012-
<p><a href="https://demos.springdoc.org/spring-cloud-function-webflux/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 3 and Spring Cloud Function WebFlux</a></p>
1998+
<p><a href="https://demos1.springdoc.org/spring-cloud-function-webflux/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 4 and Spring Cloud Function WebFlux</a></p>
20131999
</li>
20142000
<li>
2015-
<p><a href="https://demos.springdoc.org/demo-microservices/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 3 and Spring Cloud Gateway</a></p>
2001+
<p><a href="https://demos1.springdoc.org/demo-microservices/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 4 and Spring Cloud Gateway</a></p>
20162002
</li>
20172003
</ul>
20182004
</div>
@@ -2027,7 +2013,7 @@ <h3 id="source-code-of-the-demo-applications"><a class="anchor" href="#source-co
20272013
<div class="ulist">
20282014
<ul>
20292015
<li>
2030-
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/master" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi-demos/tree/master</a></p>
2016+
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/4.x" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi-demos/tree/4.x</a></p>
20312017
</li>
20322018
</ul>
20332019
</div>
@@ -2060,7 +2046,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
20602046
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
20612047
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
20622048
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
2063-
&lt;version&gt;2.8.10&lt;/version&gt;
2049+
&lt;version&gt;3.0.0-M1&lt;/version&gt;
20642050
&lt;/dependency&gt;</code></pre>
20652051
</div>
20662052
</div>
@@ -2483,7 +2469,7 @@ <h3 id="how-can-i-define-multiple-openapi-definitions-in-one-spring-boot-project
24832469
<div class="ulist">
24842470
<ul>
24852471
<li>
2486-
<p><a href="https://github.com/springdoc/springdoc-openapi/tree/main/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app68" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/tree/main/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app68</a></p>
2472+
<p><a href="https://github.com/springdoc/springdoc-openapi/tree/spring-boot-4/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app68" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/tree/spring-boot-4/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app68</a></p>
24872473
</li>
24882474
</ul>
24892475
</div>
@@ -3040,7 +3026,7 @@ <h3 id="how-can-i-test-the-swagger-ui"><a class="anchor" href="#how-can-i-test-t
30403026
<div class="ulist">
30413027
<ul>
30423028
<li>
3043-
<p><a href="https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java</a></p>
3029+
<p><a href="https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java</a></p>
30443030
</li>
30453031
</ul>
30463032
</div>
@@ -3060,7 +3046,7 @@ <h3 id="how-can-i-customise-the-openapi-object"><a class="anchor" href="#how-can
30603046
<div class="ulist">
30613047
<ul>
30623048
<li>
3063-
<p><a href="https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java</a></p>
3049+
<p><a href="https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java</a></p>
30643050
</li>
30653051
</ul>
30663052
</div>
@@ -4379,10 +4365,10 @@ <h3 id="how-to-integrate-open-api-3-with-spring-project-not-spring-boot"><a clas
43794365
<div class="sect2">
43804366
<h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot"><a class="anchor" href="#what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot"></a>12.79. What is the compatibility matrix of <code>springdoc-openapi</code> with <code>spring-boot</code> ?</h3>
43814367
<div class="paragraph">
4382-
<p><code>springdoc-openapi 2.x</code> is compatible with <code>spring-boot 3</code>.</p>
4368+
<p><code>springdoc-openapi 3.x</code> is compatible with <code>spring-boot 4</code>.</p>
43834369
</div>
43844370
<div class="paragraph">
4385-
<p>In general, <strong>you should only pick the last stable version as per today 2.8.10.</strong></p>
4371+
<p>In general, <strong>you should only pick the last stable version as per today 3.0.0-M1.</strong></p>
43864372
</div>
43874373
<div class="paragraph">
43884374
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>
@@ -4398,56 +4384,8 @@ <h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">
43984384
<td class="tableblock halign-left valign-top"><p class="tableblock">Springdoc OpenAPI Versions</p></td>
43994385
</tr>
44004386
<tr>
4401-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3.5.x</code></p></td>
4402-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.8.x</code></p></td>
4403-
</tr>
4404-
<tr>
4405-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3.4.x</code></p></td>
4406-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.7.x</code> - <code>2.8.x</code></p></td>
4407-
</tr>
4408-
<tr>
4409-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3.3.x</code></p></td>
4410-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.6.x</code></p></td>
4411-
</tr>
4412-
<tr>
4413-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3.2.x</code></p></td>
4414-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.3.x</code> - <code>2.5.x</code></p></td>
4415-
</tr>
4416-
<tr>
4417-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3.1.x</code></p></td>
4418-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.2.x</code></p></td>
4419-
</tr>
4420-
<tr>
4387+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>4.0.x</code></p></td>
44214388
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3.0.x</code></p></td>
4422-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.0.x</code> - <code>2.1.x</code></p></td>
4423-
</tr>
4424-
<tr>
4425-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.7.x</code>, <code>1.5.x</code></p></td>
4426-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.6.0</code>+</p></td>
4427-
</tr>
4428-
<tr>
4429-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.6.x</code>, <code>1.5.x</code></p></td>
4430-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.6.0</code>+</p></td>
4431-
</tr>
4432-
<tr>
4433-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.5.x</code>, <code>1.5.x</code></p></td>
4434-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.5.9</code>+</p></td>
4435-
</tr>
4436-
<tr>
4437-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.4.x</code>, <code>1.5.x</code></p></td>
4438-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.5.0</code>+</p></td>
4439-
</tr>
4440-
<tr>
4441-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.3.x</code>, <code>1.5.x</code></p></td>
4442-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.4.0</code>+</p></td>
4443-
</tr>
4444-
<tr>
4445-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.2.x</code>, <code>1.5.x</code></p></td>
4446-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.2.1</code>+</p></td>
4447-
</tr>
4448-
<tr>
4449-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.0.x</code>, <code>1.5.x</code></p></td>
4450-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.0.0</code>+</p></td>
44514389
</tr>
44524390
</tbody>
44534391
</table>
@@ -4501,7 +4439,7 @@ <h3 id="some-parameters-are-not-generated-in-the-resulting-openapi-spec"><a clas
45014439
</div>
45024440
<div id="footer">
45034441
<div id="footer-text">
4504-
Last updated 2025-08-22 12:55:06 +0200
4442+
Last updated 2025-08-22 15:01:19 +0200
45054443
</div>
45064444
</div>
45074445
</div>

‎docs/v4/intro.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ <h2 id="Introduction"><a class="anchor" href="#Introduction"></a>Introduction</h
4949
<p>OpenAPI 3</p>
5050
</li>
5151
<li>
52-
<p>Spring-boot v3 (Java 17 &amp; Jakarta EE 9)</p>
52+
<p>Spring-boot v4 (Java 17 &amp; Jakarta EE 9)</p>
5353
</li>
5454
<li>
5555
<p>JSR-303, specifically for @NotNull, @Min, @Max, and @Size.</p>
@@ -81,7 +81,7 @@ <h2 id="Introduction"><a class="anchor" href="#Introduction"></a>Introduction</h
8181
</div>
8282
<div id="footer">
8383
<div id="footer-text">
84-
Last updated 2024-10-06 14:24:00 +0200
84+
Last updated 2025-08-22 15:03:46 +0200
8585
</div>
8686
</div>
8787
</div>

‎src/docs/asciidoc/index.adoc‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
= springdoc-openapi v{springdoc-version}
22
include::_attributes.adoc[]
33

4-
IMPORTANT: ``springdoc-openapi v2.8.11 `` is the latest Open Source release supporting Spring Boot 3.x.
5-
An extended support for https://springdoc.org/v2[*springdoc-openapi v2*] project is now available for organizations that need support beyond 2026. +
4+
IMPORTANT: ``springdoc-openapi v1.8.0 `` is the latest Open Source release supporting Spring Boot 2.x and 1.x. +
5+
An extended support for https://springdoc.org/v1[*springdoc-openapi v1*] project is now available for organizations that need support beyond 2023. +
66
For more details, feel free to reach out: sales@springdoc.org
77

88
`springdoc-openapi` is on link:https://opencollective.com/springdoc[Open Collective, window="_blank"]. If you ❤️ this project consider becoming a link:https://github.com/sponsors/springdoc[sponsor, window="_blank"].
@@ -44,6 +44,8 @@ include::plugins.adoc[]
4444

4545
include::demos.adoc[]
4646

47+
include::migrating-from-springdoc-v1.adoc[]
48+
4749
include::migrating-from-springfox.adoc[]
4850

4951
include::other-resources.adoc[]

‎src/docs/asciidoc/migrating-from-springdoc-v1.adoc‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
[[migrating-from-springdoc-v1]]
2+
== Migrating from springdoc-openapi v1
3+
4+
All the modules have been renamed.
5+
`springdoc-openapi-starter-common` integrates many spring modules support in order to hide the maximum of complexity.
6+
It allows the support out of the box for `Actuator` / `Spring Cloud Function` / `Spring Data Rest`/ `Spring Native`/ `Spring Hateoas` / `Spring Securtiy` / `Kotlin`/ `Javadoc`.
7+
8+
The following table describes the main modules changes:
9+
10+
|===
11+
|springdoc-openapi-v1 | springdoc-openapi-v2 | Description
12+
13+
|`springdoc-openapi-common` |`springdoc-openapi-starter-common` | Includes foundation `springdoc-openapi` features
14+
|`springdoc-openapi-data-rest` | `springdoc-openapi-starter-common` | For Spring Data Rest support
15+
|`springdoc-openapi-groovy` | `springdoc-openapi-starter-common` | For Groovy support
16+
|`springdoc-openapi-hateoas` | `springdoc-openapi-starter-common` | For Spring Hateoas support
17+
|`springdoc-openapi-javadoc` | `springdoc-openapi-starter-common` | For Javadoc support
18+
|`springdoc-openapi-kotlin`| `springdoc-openapi-starter-common` | For Kotlin support
19+
|`springdoc-openapi-security` | `springdoc-openapi-starter-common` | For Spring Security support
20+
|`springdoc-openapi-webmvc-core`| `springdoc-openapi-starter-webmvc-api` | For Spring WebMvc support
21+
|`springdoc-openapi-webflux-core` | `springdoc-openapi-starter-webflux-api` | For Spring WebFlux support
22+
|`springdoc-openapi-ui` | `springdoc-openapi-starter-webmvc-ui` | For using the Swagger-UI in a Spring WebMvc context
23+
|`springdoc-openapi-webflux-ui` | `springdoc-openapi-starter-webflux-ui` | For using the Swagger-UI in a Spring WebFlux context
24+
|===
25+
26+
IMPORTANT: classes/annotations changes
27+
28+
|===
29+
|springdoc-openapi-v1 | springdoc-openapi-v2
30+
31+
|`org.springdoc.core.SpringDocUtils` | `org.springdoc.core.utils.SpringDocUtils`
32+
|`org.springdoc.api.annotations.ParameterObject` | `org.springdoc.core.annotations.ParameterObject`
33+
|`org.springdoc.core.GroupedOpenApi` | `org.springdoc.core.models.GroupedOpenApi`
34+
|`org.springdoc.core.customizers.OpenApiCustomiser` | `org.springdoc.core.customizers.OpenApiCustomizer`
35+
|`org.springdoc.core.Constants` | `org.springdoc.core.utils.Constants`
36+
|`org.springdoc.core.SwaggerUiConfigParameters` | `org.springdoc.core.properties.SwaggerUiConfigParameters`
37+
|===
38+
39+
TIP: Migration tips
40+
41+
The following modules are not anymore needed and can be removed:
42+
43+
- `springdoc-openapi-javadoc`
44+
- `springdoc-openapi-kotlin`
45+
- `springdoc-openapi-data-rest`
46+
- `springdoc-openapi-security`
47+
- `springdoc-openapi-webmvc-core`
48+
- `springdoc-openapi-webflux-core`
49+
- `springdoc-openapi-hateoas`
50+
- `springdoc-openapi-groovy`
51+
52+
In addition:
53+
54+
* Replace `springdoc-openapi-ui` by `springdoc-openapi-starter-webmvc-ui`
55+
* Replace `springdoc-openapi-webflux-ui` by `springdoc-openapi-starter-webflux-ui`
56+

0 commit comments

Comments
 (0)