Skip to content

Commit 96d2c0b

Browse files
bnasslahsenbnasslahsen
committed
update documentation for spring-boot v3
1 parent cda81ae commit 96d2c0b

File tree

15 files changed

+63
-31
lines changed

15 files changed

+63
-31
lines changed

‎docs/index.html‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ <h2 id="Introduction"><a class="anchor" href="#Introduction"></a>1. Introduction
269269
<p>OpenAPI 3</p>
270270
</li>
271271
<li>
272-
<p>Spring-boot (v1 and v2)</p>
272+
<p>Spring-boot (v1, v2 and v3)</p>
273273
</li>
274274
<li>
275275
<p>JSR-303, specifically for @NotNull, @Min, @Max, and @Size.</p>
@@ -288,6 +288,18 @@ <h2 id="Introduction"><a class="anchor" href="#Introduction"></a>1. Introduction
288288
<div class="paragraph">
289289
<p>The following video introduces the Library:</p>
290290
</div>
291+
<div class="admonitionblock important">
292+
<table>
293+
<tr>
294+
<td class="icon">
295+
<i class="fa icon-important" title="Important"></i>
296+
</td>
297+
<td class="content">
298+
For <strong>spring-boot v3</strong> support, make sure you use <a href="https://springdoc.org/v2"><strong>springdoc-openapi v2</strong></a>
299+
</td>
300+
</tr>
301+
</table>
302+
</div>
291303
<div class="imageblock">
292304
<div class="content">
293305
<a class="image" href="https://youtu.be/utRxyPfFlDw" target="_blank" rel="noopener"><img src="img/springdoc-openapi-prez.gif" alt="spring.io conference"></a>

‎docs/intro.html‎

Lines changed: 14 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 (v1 and v2)</p>
52+
<p>Spring-boot (v1, v2 and v3)</p>
5353
</li>
5454
<li>
5555
<p>JSR-303, specifically for @NotNull, @Min, @Max, and @Size.</p>
@@ -68,6 +68,18 @@ <h2 id="Introduction"><a class="anchor" href="#Introduction"></a>Introduction</h
6868
<div class="paragraph">
6969
<p>The following video introduces the Library:</p>
7070
</div>
71+
<div class="admonitionblock important">
72+
<table>
73+
<tr>
74+
<td class="icon">
75+
<i class="fa icon-important" title="Important"></i>
76+
</td>
77+
<td class="content">
78+
For <strong>spring-boot v3</strong> support, make sure you use <a href="https://springdoc.org/v2"><strong>springdoc-openapi v2</strong></a>
79+
</td>
80+
</tr>
81+
</table>
82+
</div>
7183
<div class="imageblock">
7284
<div class="content">
7385
<a class="image" href="https://youtu.be/utRxyPfFlDw" target="_blank" rel="noopener"><img src="img/springdoc-openapi-prez.gif" alt="spring.io conference"></a>
@@ -81,7 +93,7 @@ <h2 id="Introduction"><a class="anchor" href="#Introduction"></a>Introduction</h
8193
</div>
8294
<div id="footer">
8395
<div id="footer-text">
84-
Last updated 2022-08-07 00:58:43 +0200
96+
Last updated 2022-11-24 23:43:06 +0100
8597
</div>
8698
</div>
8799
</div>

‎docs/v2/demos.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ <h3 id="_springdoc_applications_demos"><a class="anchor" href="#_springdoc_appli
5454
<li>
5555
<p><a href="http://144.24.171.248:8087/" target="_blank" rel="noopener">Demo Spring Boot 3 and Spring Cloud Function WebFlux</a></p>
5656
</li>
57+
<li>
58+
<p><a href="http://144.24.171.248:8060/" target="_blank" rel="noopener">Demo Spring Boot 3 and Spring Cloud Gateway</a></p>
59+
</li>
5760
</ul>
5861
</div>
5962
<div class="imageblock">
@@ -77,7 +80,7 @@ <h3 id="_source_code_of_the_demo_applications"><a class="anchor" href="#_source_
7780
</div>
7881
<div id="footer">
7982
<div id="footer-text">
80-
Last updated 2022-08-07 00:58:43 +0200
83+
Last updated 2022-11-24 23:36:43 +0100
8184
</div>
8285
</div>
8386
</div>

‎docs/v2/faq.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1801,7 +1801,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
18011801
<p><code>springdoc-openapi 2.x</code> is compatible with <code>spring-boot 3</code>.</p>
18021802
</div>
18031803
<div class="paragraph">
1804-
<p>In general, <strong>you should only pick the last stable version as per today 2.0.0-RC2.</strong></p>
1804+
<p>In general, <strong>you should only pick the last stable version as per today 2.0.0.</strong></p>
18051805
</div>
18061806
<div class="paragraph">
18071807
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>
@@ -1818,7 +1818,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
18181818
</tr>
18191819
<tr>
18201820
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3.0.x</code></p></td>
1821-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.0.0-RC2</code>+</p></td>
1821+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.0.x</code>+</p></td>
18221822
</tr>
18231823
<tr>
18241824
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.7.x</code>, <code>1.5.x</code></p></td>
@@ -1856,7 +1856,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
18561856
</div>
18571857
<div id="footer">
18581858
<div id="footer-text">
1859-
Last updated 2022-11-20 13:42:11 +0100
1859+
Last updated 2022-11-24 23:38:09 +0100
18601860
</div>
18611861
</div>
18621862
</div>

‎docs/v2/getting-started.html‎

Lines changed: 2 additions & 2 deletions
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.0.0-RC2&lt;/version&gt;
43+
&lt;version&gt;2.0.0&lt;/version&gt;
4444
&lt;/dependency&gt;</code></pre>
4545
</div>
4646
</div>
@@ -96,7 +96,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
9696
</div>
9797
<div id="footer">
9898
<div id="footer-text">
99-
Last updated 2022-11-20 13:42:11 +0100
99+
Last updated 2022-11-24 23:37:28 +0100
100100
</div>
101101
</div>
102102
</div>

‎docs/v2/index.html‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
77
<meta name="generator" content="Asciidoctor 2.0.15">
88
<meta name="author" content="Library for OpenAPI 3 with spring-boot By Badr NASS LAHSEN">
9-
<title>springdoc-openapi v2.0.0-RC2</title>
9+
<title>springdoc-openapi v2.0.0</title>
1010
<link rel="stylesheet" href="css/site.css">
1111
<style>
1212
#header #revnumber {
@@ -33,7 +33,7 @@
3333
<div id="main" class="contained">
3434
<div id="doc" class="doc">
3535
<div id="header">
36-
<h1>springdoc-openapi v2.0.0-RC2</h1>
36+
<h1>springdoc-openapi v2.0.0</h1>
3737
<div class="details">
3838
<span id="author" class="author">Library for OpenAPI 3 with spring-boot By Badr NASS LAHSEN</span><br>
3939
</div>
@@ -293,7 +293,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>2. Gettin
293293
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
294294
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
295295
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
296-
&lt;version&gt;2.0.0-RC2&lt;/version&gt;
296+
&lt;version&gt;2.0.0&lt;/version&gt;
297297
&lt;/dependency&gt;</code></pre>
298298
</div>
299299
</div>
@@ -402,7 +402,7 @@ <h3 id="spring-webmvc-support"><a class="anchor" href="#spring-webmvc-support"><
402402
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
403403
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
404404
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-api&lt;/artifactId&gt;
405-
&lt;version&gt;2.0.0-RC2&lt;/version&gt;
405+
&lt;version&gt;2.0.0&lt;/version&gt;
406406
&lt;/dependency&gt;</code></pre>
407407
</div>
408408
</div>
@@ -454,7 +454,7 @@ <h3 id="spring-webflux-support"><a class="anchor" href="#spring-webflux-support"
454454
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
455455
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
456456
&lt;artifactId&gt;springdoc-openapi-starter-webflux-ui&lt;/artifactId&gt;
457-
&lt;version&gt;2.0.0-RC2&lt;/version&gt;
457+
&lt;version&gt;2.0.0&lt;/version&gt;
458458
&lt;/dependency&gt;</code></pre>
459459
</div>
460460
</div>
@@ -1864,6 +1864,9 @@ <h3 id="springdoc-applications-demos"><a class="anchor" href="#springdoc-applica
18641864
<li>
18651865
<p><a href="http://144.24.171.248:8087/" target="_blank" rel="noopener">Demo Spring Boot 3 and Spring Cloud Function WebFlux</a></p>
18661866
</li>
1867+
<li>
1868+
<p><a href="http://144.24.171.248:8060/" target="_blank" rel="noopener">Demo Spring Boot 3 and Spring Cloud Gateway</a></p>
1869+
</li>
18671870
</ul>
18681871
</div>
18691872
<div class="imageblock">
@@ -1911,7 +1914,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
19111914
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
19121915
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
19131916
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
1914-
&lt;version&gt;2.0.0-RC2&lt;/version&gt;
1917+
&lt;version&gt;2.0.0&lt;/version&gt;
19151918
&lt;/dependency&gt;</code></pre>
19161919
</div>
19171920
</div>
@@ -4066,7 +4069,7 @@ <h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">
40664069
<p><code>springdoc-openapi 2.x</code> is compatible with <code>spring-boot 3</code>.</p>
40674070
</div>
40684071
<div class="paragraph">
4069-
<p>In general, <strong>you should only pick the last stable version as per today 2.0.0-RC2.</strong></p>
4072+
<p>In general, <strong>you should only pick the last stable version as per today 2.0.0.</strong></p>
40704073
</div>
40714074
<div class="paragraph">
40724075
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>
@@ -4083,7 +4086,7 @@ <h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">
40834086
</tr>
40844087
<tr>
40854088
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3.0.x</code></p></td>
4086-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.0.0-RC2</code>+</p></td>
4089+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.0.x</code>+</p></td>
40874090
</tr>
40884091
<tr>
40894092
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.7.x</code>, <code>1.5.x</code></p></td>
@@ -4133,7 +4136,7 @@ <h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">
41334136
</div>
41344137
<div id="footer">
41354138
<div id="footer-text">
4136-
Last updated 2022-11-20 13:42:11 +0100
4139+
Last updated 2022-11-24 23:37:28 +0100
41374140
</div>
41384141
</div>
41394142

‎docs/v2/migrating-from-springfox.html‎

Lines changed: 2 additions & 2 deletions
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.0.0-RC2&lt;/version&gt;
47+
&lt;version&gt;2.0.0&lt;/version&gt;
4848
&lt;/dependency&gt;</code></pre>
4949
</div>
5050
</div>
@@ -217,7 +217,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
217217
</div>
218218
<div id="footer">
219219
<div id="footer-text">
220-
Last updated 2022-11-20 13:42:11 +0100
220+
Last updated 2022-11-24 23:37:28 +0100
221221
</div>
222222
</div>
223223
</div>

‎docs/v2/modules.html‎

Lines changed: 3 additions & 3 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.0.0-RC2&lt;/version&gt;
76+
&lt;version&gt;2.0.0&lt;/version&gt;
7777
&lt;/dependency&gt;</code></pre>
7878
</div>
7979
</div>
@@ -125,7 +125,7 @@ <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-ui&lt;/artifactId&gt;
128-
&lt;version&gt;2.0.0-RC2&lt;/version&gt;
128+
&lt;version&gt;2.0.0&lt;/version&gt;
129129
&lt;/dependency&gt;</code></pre>
130130
</div>
131131
</div>
@@ -508,7 +508,7 @@ <h3 id="_javadoc_support"><a class="anchor" href="#_javadoc_support"></a>Javadoc
508508
</div>
509509
<div id="footer">
510510
<div id="footer-text">
511-
Last updated 2022-11-20 13:42:11 +0100
511+
Last updated 2022-11-24 23:37:28 +0100
512512
</div>
513513
</div>
514514
</div>

‎src/docs/asciidoc/intro.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ This documentation can be completed by comments using swagger-api annotations.
1010
This library supports:
1111

1212
* OpenAPI 3
13-
* Spring-boot (v1 and v2)
13+
* Spring-boot (v1, v2 and v3)
1414
* JSR-303, specifically for @NotNull, @Min, @Max, and @Size.
1515
* Swagger-ui
1616
* OAuth 2
1717
* GraalVM native images
1818

1919
The following video introduces the Library:
2020

21+
IMPORTANT: For *spring-boot v3* support, make sure you use https://springdoc.org/v2[*springdoc-openapi v2*]
2122

2223
[link=https://youtu.be/utRxyPfFlDw,window=_blank]
2324
image::img/springdoc-openapi-prez.gif[spring.io conference]

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
* link:http://144.24.171.248:8085/[Demo Spring Boot 3 and Spring Hateoas with OpenAPI 3, window="_blank"]
99
* link:http://144.24.171.248:8086/[Demo Spring Boot 3 and Spring Cloud Function Web MVC, window="_blank"]
1010
* link:http://144.24.171.248:8087/[Demo Spring Boot 3 and Spring Cloud Function WebFlux, window="_blank"]
11+
* link:http://144.24.171.248:8060/[Demo Spring Boot 3 and Spring Cloud Gateway, window="_blank"]
1112

1213
image::img/pets.png[pets.png]
1314

0 commit comments

Comments
 (0)