You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/faq.html
+22-16Lines changed: 22 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -924,38 +924,44 @@ <h3 id="_can_i_use_spring_property_with_swagger_annotations">Can I use spring pr
924
924
<p>Its also possible to declare security URLs for <code>@OAuthFlow</code>: <code>openIdConnectUrl</code> * <code>authorizationUrl</code> * <code>refreshUrl</code> * <code>tokenUrl</code></p>
925
925
</li>
926
926
<li>
927
-
<p>The support of spring property resolver for <code>@Schema</code>: <code>name</code> * <code>title</code> * <code>description</code> , by setting <code>springdoc.api-docs.resolve-schema-properties</code> to <code>true</code>
928
-
=== How can I disable springdoc-openapi cache?</p>
929
-
</li>
930
-
<li>
931
-
<p>By default, the OpenAPI description is calculated once, and then cached.</p>
927
+
<p>The support of spring property resolver for <code>@Schema</code>: <code>name</code> * <code>title</code> * <code>description</code> , by setting <code>springdoc.api-docs.resolve-schema-properties</code> to <code>true</code></p>
932
928
</li>
929
+
</ul>
930
+
</div>
931
+
</div>
932
+
<divclass="sect2">
933
+
<h3id="_how_is_server_url_generated">How is server URL generated ?</h3>
934
+
<divclass="ulist">
935
+
<ul>
933
936
<li>
934
-
<p>Sometimes the same swagger-ui is served behind internal and external proxies. some users want the server URL, to be computed on each http request.</p>
937
+
<p>Generating automatically server URL may be useful, if the documentation is not present.</p>
935
938
</li>
936
939
<li>
937
-
<p>In order to disable springdoc cache, you will have to set the following property:</p>
940
+
<p>If the server annotations are present, they will be used instead.</p>
938
941
</li>
939
942
</ul>
940
943
</div>
941
-
<divclass="listingblock">
942
-
<divclass="content">
943
-
<pre>springdoc.cache.disabled= true</pre>
944
-
</div>
945
-
</div>
946
944
</div>
947
945
<divclass="sect2">
948
-
<h3id="_how_is_server_url_generated">How is server URL generated ?</h3>
946
+
<h3id="_how_can_i_disable_springdoc_openapi_cache">How can I disable springdoc-openapi cache?</h3>
949
947
<divclass="ulist">
950
948
<ul>
951
949
<li>
952
-
<p>Generating automatically server URL may be useful, if the documentation is not present.</p>
950
+
<p>By default, the OpenAPI description is calculated once, and then cached.</p>
953
951
</li>
954
952
<li>
955
-
<p>If the server annotations are present, they will be used instead.</p>
953
+
<p>Sometimes the same swagger-ui is served behind internal and external proxies. some users want the server URL, to be computed on each http request.</p>
954
+
</li>
955
+
<li>
956
+
<p>In order to disable springdoc cache, you will have to set the following property:</p>
956
957
</li>
957
958
</ul>
958
959
</div>
960
+
<divclass="listingblock">
961
+
<divclass="content">
962
+
<pre>springdoc.cache.disabled= true</pre>
963
+
</div>
964
+
</div>
959
965
</div>
960
966
<divclass="sect2">
961
967
<h3id="_how_can_i_expose_the_api_docs_endpoints_without_using_the_swagger_ui">How can I expose the api-docs endpoints without using the <code>swagger-ui</code>?</h3>
Copy file name to clipboardExpand all lines: src/docs/asciidoc/faq.adoc
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -442,6 +442,11 @@ public OpenAPI customOpenAPI() {
442
442
* The support of spring property resolver for `@ApiResponse`: `description`
443
443
* Its also possible to declare security URLs for `@OAuthFlow`: `openIdConnectUrl` * `authorizationUrl` * `refreshUrl` * `tokenUrl`
444
444
* The support of spring property resolver for `@Schema`: `name` * `title` * `description` , by setting `springdoc.api-docs.resolve-schema-properties` to `true`
445
+
446
+
=== How is server URL generated ?
447
+
* Generating automatically server URL may be useful, if the documentation is not present.
448
+
* If the server annotations are present, they will be used instead.
449
+
445
450
=== How can I disable springdoc-openapi cache?
446
451
* By default, the OpenAPI description is calculated once, and then cached.
447
452
* Sometimes the same swagger-ui is served behind internal and external proxies. some users want the server URL, to be computed on each http request.
@@ -451,11 +456,6 @@ public OpenAPI customOpenAPI() {
451
456
springdoc.cache.disabled= true
452
457
----
453
458
454
-
455
-
=== How is server URL generated ?
456
-
* Generating automatically server URL may be useful, if the documentation is not present.
457
-
* If the server annotations are present, they will be used instead.
458
-
459
459
=== How can I expose the api-docs endpoints without using the `swagger-ui`?
460
460
* You should use the `springdoc-openapi-core` dependency only:
0 commit comments