Skip to content

Commit 090a012

Browse files
bnasslahsenbnasslahsen
committed
doc update
1 parent ae06bc2 commit 090a012

File tree

1 file changed

+237
-0
lines changed

1 file changed

+237
-0
lines changed

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

Lines changed: 237 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,237 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<meta name="generator" content="Asciidoctor 2.0.15">
8+
<title>Migrating from springdoc-openapi v1</title>
9+
<link rel="stylesheet" href="css/site.css">
10+
<script src="js/setup.js"></script><script defer src="js/site.js"></script>
11+
12+
</head>
13+
<body class="article"><div id="banner-container" class="container" role="banner">
14+
<div id="banner" class="contained" role="banner">
15+
<div id="switch-theme">
16+
<input type="checkbox" id="switch-theme-checkbox" />
17+
<label for="switch-theme-checkbox">Dark Theme</label>
18+
</div>
19+
</div>
20+
</div>
21+
<div id="tocbar-container" class="container" role="navigation">
22+
<div id="tocbar" class="contained" role="navigation">
23+
<button id="toggle-toc"></button>
24+
</div>
25+
</div>
26+
<div id="main-container" class="container">
27+
<div id="main" class="contained">
28+
<div id="doc" class="doc">
29+
<div id="header">
30+
</div>
31+
<div id="content">
32+
<div class="sect1">
33+
<h2 id="migrating-from-springdoc-v1"><a class="anchor" href="#migrating-from-springdoc-v1"></a>Migrating from springdoc-openapi v1</h2>
34+
<div class="sectionbody">
35+
<div class="paragraph">
36+
<p>All the modules have been renamed.
37+
<code>springdoc-openapi-starter-common</code> integrates many spring modules support in order to hide the maximum of complexity.
38+
It allows the support out of the box for <code>Actuator</code> / <code>Spring Cloud Function</code> / <code>Spring Data Rest</code>/ <code>Spring Native</code>/ <code>Spring Hateoas</code> / <code>Spring Securtiy</code> / <code>Kotlin</code>/ <code>Javadoc</code>.</p>
39+
</div>
40+
<div class="paragraph">
41+
<p>The following table describes the main modules changes:</p>
42+
</div>
43+
<table class="tableblock frame-all grid-all stretch">
44+
<colgroup>
45+
<col style="width: 33.3333%;">
46+
<col style="width: 33.3333%;">
47+
<col style="width: 33.3334%;">
48+
</colgroup>
49+
<thead>
50+
<tr>
51+
<th class="tableblock halign-left valign-top">springdoc-openapi-v1</th>
52+
<th class="tableblock halign-left valign-top">springdoc-openapi-v2</th>
53+
<th class="tableblock halign-left valign-top">Description</th>
54+
</tr>
55+
</thead>
56+
<tbody>
57+
<tr>
58+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-common</code></p></td>
59+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-starter-common</code></p></td>
60+
<td class="tableblock halign-left valign-top"><p class="tableblock">Includes foundation <code>springdoc-openapi</code> features</p></td>
61+
</tr>
62+
<tr>
63+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-data-rest</code></p></td>
64+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-starter-common</code></p></td>
65+
<td class="tableblock halign-left valign-top"><p class="tableblock">For Spring Data Rest support</p></td>
66+
</tr>
67+
<tr>
68+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-groovy</code></p></td>
69+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-starter-common</code></p></td>
70+
<td class="tableblock halign-left valign-top"><p class="tableblock">For Groovy support</p></td>
71+
</tr>
72+
<tr>
73+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-hateoas</code></p></td>
74+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-starter-common</code></p></td>
75+
<td class="tableblock halign-left valign-top"><p class="tableblock">For Spring Hateoas support</p></td>
76+
</tr>
77+
<tr>
78+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-javadoc</code></p></td>
79+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-starter-common</code></p></td>
80+
<td class="tableblock halign-left valign-top"><p class="tableblock">For Javadoc support</p></td>
81+
</tr>
82+
<tr>
83+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-kotlin</code></p></td>
84+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-starter-common</code></p></td>
85+
<td class="tableblock halign-left valign-top"><p class="tableblock">For Kotlin support</p></td>
86+
</tr>
87+
<tr>
88+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-native</code></p></td>
89+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-starter-common</code></p></td>
90+
<td class="tableblock halign-left valign-top"><p class="tableblock">For Spring Native support</p></td>
91+
</tr>
92+
<tr>
93+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-security</code></p></td>
94+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-starter-common</code></p></td>
95+
<td class="tableblock halign-left valign-top"><p class="tableblock">For Spring Security support</p></td>
96+
</tr>
97+
<tr>
98+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-webmvc-core</code></p></td>
99+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-starter-webmvc-api</code></p></td>
100+
<td class="tableblock halign-left valign-top"><p class="tableblock">For Spring WebMvc support</p></td>
101+
</tr>
102+
<tr>
103+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-webflux-core</code></p></td>
104+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-starter-webflux-api</code></p></td>
105+
<td class="tableblock halign-left valign-top"><p class="tableblock">For Spring WebFlux support</p></td>
106+
</tr>
107+
<tr>
108+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-ui</code></p></td>
109+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-starter-webmvc-ui</code></p></td>
110+
<td class="tableblock halign-left valign-top"><p class="tableblock">For using the Swagger-UI in a Spring WebMvc context</p></td>
111+
</tr>
112+
<tr>
113+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-webflux-ui</code></p></td>
114+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>springdoc-openapi-starter-webflux-ui</code></p></td>
115+
<td class="tableblock halign-left valign-top"><p class="tableblock">For using the Swagger-UI in a Spring WebFlux context</p></td>
116+
</tr>
117+
</tbody>
118+
</table>
119+
<div class="admonitionblock important">
120+
<table>
121+
<tr>
122+
<td class="icon">
123+
<i class="fa icon-important" title="Important"></i>
124+
</td>
125+
<td class="content">
126+
classes/annotations changes
127+
</td>
128+
</tr>
129+
</table>
130+
</div>
131+
<table class="tableblock frame-all grid-all stretch">
132+
<colgroup>
133+
<col style="width: 50%;">
134+
<col style="width: 50%;">
135+
</colgroup>
136+
<thead>
137+
<tr>
138+
<th class="tableblock halign-left valign-top">springdoc-openapi-v1</th>
139+
<th class="tableblock halign-left valign-top">springdoc-openapi-v2</th>
140+
</tr>
141+
</thead>
142+
<tbody>
143+
<tr>
144+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springdoc.core.SpringDocUtils</code></p></td>
145+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springdoc.core.utils.SpringDocUtils</code></p></td>
146+
</tr>
147+
<tr>
148+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springdoc.api.annotations.ParameterObject</code></p></td>
149+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springdoc.core.annotations.ParameterObject</code></p></td>
150+
</tr>
151+
<tr>
152+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springdoc.core.GroupedOpenApi</code></p></td>
153+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springdoc.core.models.GroupedOpenApi</code></p></td>
154+
</tr>
155+
<tr>
156+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springdoc.core.customizers.OpenApiCustomiser</code></p></td>
157+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springdoc.core.customizers.OpenApiCustomizer</code></p></td>
158+
</tr>
159+
<tr>
160+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springdoc.core.Constants</code></p></td>
161+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springdoc.core.utils.Constants</code></p></td>
162+
</tr>
163+
<tr>
164+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springdoc.core.SwaggerUiConfigParameters</code></p></td>
165+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springdoc.core.properties.SwaggerUiConfigParameters</code></p></td>
166+
</tr>
167+
</tbody>
168+
</table>
169+
<div class="admonitionblock tip">
170+
<table>
171+
<tr>
172+
<td class="icon">
173+
<i class="fa icon-tip" title="Tip"></i>
174+
</td>
175+
<td class="content">
176+
Migration tips
177+
</td>
178+
</tr>
179+
</table>
180+
</div>
181+
<div class="paragraph">
182+
<p>The following modules are not anymore needed and can be removed:</p>
183+
</div>
184+
<div class="ulist">
185+
<ul>
186+
<li>
187+
<p><code>springdoc-openapi-javadoc</code></p>
188+
</li>
189+
<li>
190+
<p><code>springdoc-openapi-kotlin</code></p>
191+
</li>
192+
<li>
193+
<p><code>springdoc-openapi-data-rest</code></p>
194+
</li>
195+
<li>
196+
<p><code>springdoc-openapi-security</code></p>
197+
</li>
198+
<li>
199+
<p><code>springdoc-openapi-webmvc-core</code></p>
200+
</li>
201+
<li>
202+
<p><code>springdoc-openapi-webflux-core</code></p>
203+
</li>
204+
<li>
205+
<p><code>springdoc-openapi-hateoas</code></p>
206+
</li>
207+
<li>
208+
<p><code>springdoc-openapi-groovy</code></p>
209+
</li>
210+
</ul>
211+
</div>
212+
<div class="paragraph">
213+
<p>In addition:</p>
214+
</div>
215+
<div class="ulist">
216+
<ul>
217+
<li>
218+
<p>Replace <code>springdoc-openapi-ui</code> by <code>springdoc-openapi-starter-webmvc-ui</code></p>
219+
</li>
220+
<li>
221+
<p>Replace <code>springdoc-openapi-webflux-ui</code> by <code>springdoc-openapi-starter-webflux-ui</code></p>
222+
</li>
223+
</ul>
224+
</div>
225+
</div>
226+
</div>
227+
</div>
228+
<div id="footer">
229+
<div id="footer-text">
230+
Last updated 2022-11-25 15:11:03 +0100
231+
</div>
232+
</div>
233+
</div>
234+
</div>
235+
</div>
236+
</body>
237+
</html>

0 commit comments

Comments
 (0)