Skip to content

Commit 7b40556

Browse files
committed
docs update
1 parent cf98fea commit 7b40556

File tree

7 files changed

+180
-123
lines changed

7 files changed

+180
-123
lines changed

docs/core-properties.html

Lines changed: 21 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -56,37 +56,37 @@
5656
<tr>
5757
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.packages-to-scan</p></td>
5858
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>*</code></p></td>
59-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of packages to scan (comma separated)</p></td>
59+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of packages to scan (comma separated)</p></td>
6060
</tr>
6161
<tr>
6262
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.paths-to-match</p></td>
6363
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/*</code></p></td>
64-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of paths to match (comma separated)</p></td>
64+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of paths to match (comma separated)</p></td>
6565
</tr>
6666
<tr>
6767
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.produces-to-match</p></td>
6868
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/*</code></p></td>
69-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of produces mediaTypes to match (comma separated)</p></td>
69+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of produces mediaTypes to match (comma separated)</p></td>
7070
</tr>
7171
<tr>
7272
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.headers-to-match</p></td>
7373
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/*</code></p></td>
74-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of headers to match (comma separated)</p></td>
74+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of headers to match (comma separated)</p></td>
7575
</tr>
7676
<tr>
7777
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.consumes-to-match</p></td>
7878
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/*</code></p></td>
79-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of consumes mediaTypes to match (comma separated)</p></td>
79+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of consumes mediaTypes to match (comma separated)</p></td>
8080
</tr>
8181
<tr>
8282
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.paths-to-exclude</p></td>
8383
<td class="tableblock halign-left valign-top"></td>
84-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of paths to exclude (comma separated)</p></td>
84+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of paths to exclude (comma separated)</p></td>
8585
</tr>
8686
<tr>
8787
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.packages-to-exclude</p></td>
8888
<td class="tableblock halign-left valign-top"></td>
89-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of packages to exclude (comma separated)</p></td>
89+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of packages to exclude (comma separated)</p></td>
9090
</tr>
9191
<tr>
9292
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.default-consumes-media-type</p></td>
@@ -96,7 +96,7 @@
9696
<tr>
9797
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.default-produces-media-type</p></td>
9898
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><strong>/</strong></code></p></td>
99-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The default produces media type.</p></td>
99+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>. The default produces media type.</p></td>
100100
</tr>
101101
<tr>
102102
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.cache.disabled</p></td>
@@ -126,52 +126,52 @@
126126
<tr>
127127
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].group</p></td>
128128
<td class="tableblock halign-left valign-top"></td>
129-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The group name</p></td>
129+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>. The group name</p></td>
130130
</tr>
131131
<tr>
132132
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].display-name</p></td>
133133
<td class="tableblock halign-left valign-top"></td>
134-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The display name of the group.</p></td>
134+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>. The display name of the group.</p></td>
135135
</tr>
136136
<tr>
137137
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].packages-to-scan</p></td>
138138
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>*</code></p></td>
139-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of packages to scan for a group (comma separated)</p></td>
139+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of packages to scan for a group (comma separated)</p></td>
140140
</tr>
141141
<tr>
142142
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].paths-to-match</p></td>
143143
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/*</code></p></td>
144-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of paths to match for a group(comma separated)</p></td>
144+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of paths to match for a group (comma separated)</p></td>
145145
</tr>
146146
<tr>
147147
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].paths-to-exclude</p></td>
148148
<td class="tableblock halign-left valign-top"><p class="tableblock">``</p></td>
149-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of paths to exclude for a group(comma separated)</p></td>
149+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of paths to exclude for a group (comma separated)</p></td>
150150
</tr>
151151
<tr>
152152
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].packages-to-exclude</p></td>
153153
<td class="tableblock halign-left valign-top"></td>
154-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of packages to exclude for a group(comma separated)</p></td>
154+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of packages to exclude for a group (comma separated)</p></td>
155155
</tr>
156156
<tr>
157157
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].produces-to-match</p></td>
158158
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/*</code></p></td>
159-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of produces mediaTypes to match (comma separated)</p></td>
159+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of produces mediaTypes to match (comma separated)</p></td>
160160
</tr>
161161
<tr>
162162
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].consumes-to-match</p></td>
163163
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/*</code></p></td>
164-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of consumes mediaTypes to match (comma separated)</p></td>
164+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of consumes mediaTypes to match (comma separated)</p></td>
165165
</tr>
166166
<tr>
167167
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].headers-to-match</p></td>
168168
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/*</code></p></td>
169-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of headers to match (comma separated)</p></td>
169+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of headers to match (comma separated)</p></td>
170170
</tr>
171171
<tr>
172172
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.webjars.prefix</p></td>
173173
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/webjars</code></p></td>
174-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>, To change the webjars prefix that is visible the URL of swagger-ui for spring-webflux.</p></td>
174+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>. To change the webjars prefix that is visible the URL of swagger-ui for spring-webflux.</p></td>
175175
</tr>
176176
<tr>
177177
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.api-docs.resolve-schema-properties</p></td>
@@ -219,14 +219,9 @@
219219
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To make spring security login-endpoint visible.</p></td>
220220
</tr>
221221
<tr>
222-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.pre-loading-enabled</p></td>
223-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
224-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. Pre-loading setting to load OpenAPI on application startup.</p></td>
225-
</tr>
226-
<tr>
227222
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.pre-loading-locales</p></td>
228223
<td class="tableblock halign-left valign-top"></td>
229-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of locales to load OpenAPI on application startup.(comma separated) If not specified, it will preload with the default Locale.</p></td>
224+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of locales to load OpenAPI on application startup (comma separated). If not specified, it will preload with the default Locale.</p></td>
230225
</tr>
231226
<tr>
232227
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.writer-with-order-by-keys</p></td>
@@ -276,7 +271,7 @@
276271
<tr>
277272
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.api-docs.version</p></td>
278273
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>openapi_3_0</code></p></td>
279-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>. To Choose <code>OpenAPI 3.0</code> or <code>OpenAPI 3.1</code> (using the value <code>OPENAPI_3_1</code>).</p></td>
274+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>. To choose <code>OpenAPI 3.0</code> or <code>OpenAPI 3.1</code> (using the value <code>OPENAPI_3_1</code>).</p></td>
280275
</tr>
281276
<tr>
282277
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.default-flat-param-object</p></td>
@@ -330,7 +325,7 @@
330325
</div>
331326
<div id="footer">
332327
<div id="footer-text">
333-
Last updated 2024-09-27 22:43:02 +0200
328+
Last updated 2024-09-27 23:10:52 +0200
334329
</div>
335330
</div>
336331
</div>

docs/faq.html

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,6 +602,34 @@ <h3 id="_how_can_i_deploy_springdoc_openapi_starter_webmvc_ui_behind_a_reverse_p
602602
</code></pre>
603603
</div>
604604
</div>
605+
<div class="ulist">
606+
<ul>
607+
<li>
608+
<p>If you need to manually adjust the URL displayed in the Swagger UI, implement the <code>ServerBaseUrlCustomizer</code> interface. This might be necessary to remove the port number, for example.</p>
609+
</li>
610+
</ul>
611+
</div>
612+
<div class="listingblock">
613+
<div class="content">
614+
<pre class="highlight"><code class="language-java" data-lang="java">@Bean
615+
public class CustomServerBaseUrlCustomizer implements ServerBaseUrlCustomizer {
616+
@Override
617+
public String customize(String serverBaseUrl) {
618+
try {
619+
URL url = new URL(serverBaseUrl);
620+
if (url.getHost().contains(".com")) {
621+
serverBaseUrl = new URL(url.getProtocol(),url.getHost(),url.getFile()).toString();
622+
}
623+
} catch (MalformedURLException ex) {
624+
// nothing we can do
625+
}
626+
627+
return serverBaseUrl;
628+
}
629+
}
630+
</code></pre>
631+
</div>
632+
</div>
605633
</div>
606634
<div class="sect2">
607635
<h3 id="_is_jsonview_annotations_in_spring_mvc_apis_supported"><a class="anchor" href="#_is_jsonview_annotations_in_spring_mvc_apis_supported"></a>Is <code>@JsonView</code> annotations in Spring MVC APIs supported?</h3>
@@ -2096,7 +2124,7 @@ <h3 id="_some_parameters_are_not_generated_in_the_resulting_openapi_spec"><a cla
20962124
</div>
20972125
<div id="footer">
20982126
<div id="footer-text">
2099-
Last updated 2024-09-27 22:58:30 +0200
2127+
Last updated 2024-09-27 23:06:26 +0200
21002128
</div>
21012129
</div>
21022130
</div>

0 commit comments

Comments
 (0)