release 2.8.13

Author: bnasslahsen

docs/core-properties.html

@@ -231,7 +231,7 @@
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.use-management-port</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To expose the swagger-ui on the actuator management port.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To expose the swagger-ui/scalar on the actuator management port.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.disable-i18n</p></td>
@@ -333,7 +333,7 @@
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-04-21 22:29:56 +0200
+Last updated 2025-09-07 17:01:40 +0200
 </div>
 </div>
 </div>

docs/getting-started.html

@@ -80,7 +80,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
 <i class="fa icon-tip" title="Tip"></i>
 </td>
 <td class="content">
-For custom path of the swagger documentation in HTML format, add a custom springdoc property, in your spring-boot configuration file: .
+For custom path of the swagger documentation in HTML format, add a custom springdoc property, in your spring-boot configuration file.
 </td>
 </tr>
 </table>
@@ -107,7 +107,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-05-04 17:47:09 +0200
+Last updated 2025-09-07 17:05:02 +0200
 </div>
 </div>
 </div>

docs/index.html

@@ -287,6 +287,9 @@ <h2 id="Introduction"><a class="anchor" href="#Introduction"></a>1. Introduction
 <p>Swagger-ui</p>
 </li>
 <li>
+<p>Scalar</p>
+</li>
+<li>
 <p>OAuth 2</p>
 </li>
 <li>
@@ -358,7 +361,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>2. Gettin
 <i class="fa icon-tip" title="Tip"></i>
 </td>
 <td class="content">
-For custom path of the swagger documentation in HTML format, add a custom springdoc property, in your spring-boot configuration file: .
+For custom path of the swagger documentation in HTML format, add a custom springdoc property, in your spring-boot configuration file.
 </td>
 </tr>
 </table>
@@ -437,7 +440,7 @@ <h3 id="spring-webmvc-support"><a class="anchor" href="#spring-webmvc-support"><
 <i class="fa icon-note" title="Note"></i>
 </td>
 <td class="content">
-This dependency is relevant if you want to generate the OpenAPI description without using the swagger-ui.
+This dependency is relevant if you want to generate the OpenAPI description without using the swagger-ui or Scalar.
 </td>
 </tr>
 </table>
@@ -524,7 +527,7 @@ <h3 id="swagger-ui-support"><a class="anchor" href="#swagger-ui-support"></a>3.4
 <div class="sect2">
 <h3 id="scalar-support"><a class="anchor" href="#scalar-support"></a>3.5. Scalar support</h3>
 <div class="paragraph">
-<p><a href="https://swagger.io/tools/swagger-ui/">Scalar</a> Scalar is an open-source API platform, designed for creating beautiful, interactive API documentation and providing a built-in REST API client, with first-class support for OpenAPI (formerly Swagger) specifications.
+<p><a href="https://scalar.com/">Scalar</a> is an open-source API platform, designed for creating beautiful, interactive API documentation and providing a built-in REST API client, with first-class support for OpenAPI (formerly Swagger) specifications.
 It’s particularly aimed at improving the developer experience when exploring APIs.</p>
 </div>
 <div class="paragraph">
@@ -534,6 +537,22 @@ <h3 id="scalar-support"><a class="anchor" href="#scalar-support"></a>3.5. Scalar
 <div class="ulist">
 <ul>
 <li>
+<p>The Swagger UI page will then be available at <code>http://server:port/context-path/scalar</code> and the OpenAPI description will be available at the following url for json format: <code>http://server:port/context-path/v3/api-docs</code></p>
+<div class="ulist">
+<ul>
+<li>
+<p>server: The server name or IP</p>
+</li>
+<li>
+<p>port: The server port</p>
+</li>
+<li>
+<p>context-path: The context path of the application</p>
+</li>
+</ul>
+</div>
+</li>
+<li>
 <p>If your project is using <code>spring-boot-starter-web</code> and you need the access to the swagger-ui, add the following dependency:</p>
 </li>
 </ul>
@@ -619,14 +638,8 @@ <h3 id="spring-security-support"><a class="anchor" href="#spring-security-suppor
 <p><code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.</p>
 </li>
 <li>
-<p>OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.</p>
-</li>
-<li>
 <p>OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.</p>
 </li>
-<li>
-<p>OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
-</li>
 </ul>
 </div>
 </div>
@@ -660,13 +673,15 @@ <h3 id="actuator-support"><a class="anchor" href="#actuator-support"></a>3.9. Ac
 </table>
 </div>
 <div class="paragraph">
-<p>To expose the swagger-ui, on the management port, you should set</p>
+<p>To expose the swagger-ui and Scalar, on the management port, you should set</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-properties" data-lang="properties">springdoc.use-management-port=true
 # This property enables the openapi and swagger-ui endpoints to be exposed beneath the actuator base path.
-management.endpoints.web.exposure.include=openapi, swagger-ui</code></pre>
+management.endpoints.web.exposure.include=openapi, swagger-ui
+# This property enables the openapi and scalar endpoints to be exposed beneath the actuator base path.
+management.endpoints.web.exposure.include=openapi, scalar</code></pre>
 </div>
 </div>
 <div class="paragraph">
@@ -677,7 +692,7 @@ <h3 id="actuator-support"><a class="anchor" href="#actuator-support"></a>3.9. Ac
 <p>For example, if you have the following settings:</p>
 </div>
 <div class="paragraph">
-<p>Two endpoints will be available:</p>
+<p>These endpoints will be available:</p>
 </div>
 <div class="olist arabic">
 <ol class="arabic">
@@ -701,6 +716,16 @@ <h3 id="actuator-support"><a class="anchor" href="#actuator-support"></a>3.9. Ac
 </ul>
 </div>
 </li>
+<li>
+<p>Or An Endpoint, that routes to the scalar:</p>
+<div class="ulist">
+<ul>
+<li>
+<p><code>http://serverName:managementPort/actuator/scalar</code></p>
+</li>
+</ul>
+</div>
+</li>
 </ol>
 </div>
 <div class="listingblock">
@@ -709,15 +734,15 @@ <h3 id="actuator-support"><a class="anchor" href="#actuator-support"></a>3.9. Ac
 </div>
 </div>
 <div class="paragraph">
-<p>For the example, you should also be able to see the springdoc-openapi endpoints:</p>
+<p>For the example, you should also be able to see the springdoc-openapi endpoints depending on the chosen UI:</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
 <p><code>http://serverName:9090/actuator</code></p>
 </li>
 <li>
-<p><code>http://serverName:9090/actuator/swagger-ui</code></p>
+<p><code>http://serverName:9090/actuator/swagger-ui</code> or <code>http://serverName:9090/actuator/scalar</code></p>
 </li>
 <li>
 <p><code>http://serverName:9090/actuator/openapi</code></p>
@@ -734,13 +759,13 @@ <h3 id="actuator-support"><a class="anchor" href="#actuator-support"></a>3.9. Ac
 <i class="fa icon-tip" title="Tip"></i>
 </td>
 <td class="content">
-If you want to reach the application endpoints, from the swagger-ui deployed beneath the actuator base path, using a different port from your application, <code>CORS for your endpoints</code> on your application level should be enabled.
+If you want to reach the application endpoints, from the swagger-ui/scalar deployed beneath the actuator base path, using a different port from your application, <code>CORS for your endpoints</code> on your application level should be enabled.
 </td>
 </tr>
 </table>
 </div>
 <div class="paragraph">
-<p>Additionally, it is also possible to combine this property, with the existing property to display the actuator endpoints in the swagger-ui.</p>
+<p>Additionally, it is also possible to combine this property, with the existing property to display the actuator endpoints in the swagger-ui/scalar.</p>
 </div>
 <div class="listingblock">
 <div class="content">
@@ -763,6 +788,16 @@ <h3 id="actuator-support"><a class="anchor" href="#actuator-support"></a>3.9. Ac
 </ul>
 </div>
 <div class="paragraph">
+<p>The scalar UI will be then accessible through the actuator port:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><code>http://serverName:managementPort/actuator/scalar</code></p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
 <p>If the management port is different from the application port and <code>springdoc.use-management-port</code> is not defined but <code>springdoc.show-actuator</code> is set to true:</p>
 </div>
 <div class="ulist">
@@ -771,6 +806,9 @@ <h3 id="actuator-support"><a class="anchor" href="#actuator-support"></a>3.9. Ac
 <p>The swagger-ui will be then accessible through the application port. For example: <code>http://serverName:applicationPort/swagger-ui.html</code></p>
 </li>
 <li>
+<p>The scalar UI will be then accessible through the application port. For example: <code>http://serverName:applicationPort/scalar</code></p>
+</li>
+<li>
 <p>A dedicated group for the actuator endpoints will be by default added.</p>
 </li>
 <li>
@@ -1584,7 +1622,7 @@ <h3 id="springdoc-openapi-core-properties"><a class="anchor" href="#springdoc-op
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.use-management-port</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To expose the swagger-ui on the actuator management port.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To expose the swagger-ui/scalar on the actuator management port.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.disable-i18n</p></td>
@@ -2475,7 +2513,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
 <div class="ulist">
 <ul>
 <li>
-<p>If the swagger-ui is served behind a proxy:</p>
+<p>If the swagger-ui/scalar is served behind a proxy:</p>
 <div class="ulist">
 <ul>
 <li>

docs/intro.html

@@ -58,6 +58,9 @@ <h2 id="Introduction"><a class="anchor" href="#Introduction"></a>Introduction</h
 <p>Swagger-ui</p>
 </li>
 <li>
+<p>Scalar</p>
+</li>
+<li>
 <p>OAuth 2</p>
 </li>
 <li>
@@ -81,7 +84,7 @@ <h2 id="Introduction"><a class="anchor" href="#Introduction"></a>Introduction</h
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-10-06 14:24:00 +0200
+Last updated 2025-09-07 17:01:40 +0200
 </div>
 </div>
 </div>

docs/migrating-from-springfox.html

@@ -181,7 +181,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
 <div class="ulist">
 <ul>
 <li>
-<p>If the swagger-ui is served behind a proxy:</p>
+<p>If the swagger-ui/scalar is served behind a proxy:</p>
 <div class="ulist">
 <ul>
 <li>
@@ -217,7 +217,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-10-06 14:24:00 +0200
+Last updated 2025-09-07 17:01:40 +0200
 </div>
 </div>
 </div>