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
{{ message }}
Repository navigation
Commit 2b3160e
Browse filesBrowse the repository at this point in the historyBrowse files
Promote v4 docs to default version, archive current docs as v2
The 3.x line is now GA, so the v4 documentation becomes the default site
version served at the root, and the previous current docs (2.8.17) are
archived under /v2 (mirroring the existing /v1 legacy docs).
- Move current root docs to v2/; move v4/ docs to root (brings mcp.adoc)
- v2 files reference {springdoc-version2} (2.8.17); root files reference
{springdoc-version} (3.0.3), keeping ui/scalar on {springdoc-version2}
- Fix include prefixes: v2/index uses v2/-prefixed includes, root index
uses bare includes
- pom.xml: add springdoc-version2 attribute, drop dangling
springdoc-upcoming-version, copy img to docs/v2/img
- Add v2/v1 older-version banner to the root index and mcp.html to sitemap
- Restore root index SEO/social meta tags and make them durable: tags live
in src/docs/seo/index-head.html and are injected into the generated root
index.html only (not v1/v2) by maven-antrun-plugin after asciidoctor runs
- Regenerate published docs/
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock"><code>Boolean</code>. To expose the swagger-ui/scalar on the actuator management port.</p></td>
234
+
<tdclass="tableblock halign-left valign-top"><pclass="tableblock"><code>Boolean</code>. To expose the swagger-ui on the actuator management port.</p></td>
<p>All properties are under the <code>springdoc.ai.mcp</code> prefix. These properties require the <code>springdoc-openapi-starter-webmvc-mcp</code> or <code>springdoc-openapi-starter-webflux-mcp</code> dependency.</p>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock"><code>String</code>. Base URL for tool execution HTTP calls. If not set, defaults to <code>http://localhost:{server.port}</code>.</p></td>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock"><code>Integer</code>. Timeout in seconds waiting for the OpenAPI spec at startup.</p></td>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock"><code>List of Strings</code>. List of ant patterns for paths to exclude from MCP tool generation.</p></td>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock"><code>Boolean</code>. When <code>true</code>, calling a mutating tool (POST/PUT/DELETE/PATCH) via MCP returns an approval-required response instead of executing the HTTP call.</p></td>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock"><code>List of Strings</code>. Comma-separated list of HTTP methods considered safe (read-only). All other methods are treated as mutating.</p></td>
396
+
</tr>
397
+
</tbody>
398
+
</table>
399
+
<divclass="admonitionblock note">
400
+
<table>
401
+
<tr>
402
+
<tdclass="icon">
403
+
<iclass="fa icon-note" title="Note"></i>
404
+
</td>
405
+
<tdclass="content">
406
+
When MCP is enabled, <code>springdoc.pre-loading-enabled</code> is automatically forced to <code>true</code> by an environment post-processor, ensuring the OpenAPI specification is available at startup for tool registration.
<p><ahref="https://demos.springdoc.org/demo-spring-boot-3-webmvc" target="_blank" rel="noopener">Demo Spring Boot 3 Web MVC with OpenAPI 3 and Swagger-UI</a></p>
40
+
<p><ahref="https://demos1.springdoc.org/demo-spring-boot-webmvc" target="_blank" rel="noopener">Demo Spring Boot 4 Web MVC with OpenAPI 3</a></p>
41
41
</li>
42
42
<li>
43
-
<p><ahref="https://demos.springdoc.org/demo-spring-boot-3-webflux/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 3 WebFlux with OpenAPI 3 and Swagger-UI</a></p>
43
+
<p><ahref="https://demos1.springdoc.org/demo-spring-boot-webflux/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 4 WebFlux with OpenAPI 3</a></p>
44
44
</li>
45
45
<li>
46
-
<p><ahref="https://demos.springdoc.org/demo-spring-boot-webmvc-scalar/scalar" target="_blank" rel="noopener">Demo Spring Boot 3 Web MVC with OpenAPI 3 and Scalar</a></p>
46
+
<p><ahref="https://demos1.springdoc.org/demo-spring-boot-webmvc-scalar/scalar" target="_blank" rel="noopener">Demo Spring Boot 4 Web MVC with OpenAPI 3 and Scalar</a></p>
47
47
</li>
48
48
<li>
49
-
<p><ahref="https://demos.springdoc.org/demo-spring-boot-webflux-scalar/scalar" target="_blank" rel="noopener">Demo Spring Boot 3 WebFlux with OpenAPI 3 and Scalar</a></p>
49
+
<p><ahref="https://demos1.springdoc.org/demo-spring-boot-webflux-scalar/scalar" target="_blank" rel="noopener">Demo Spring Boot 4 WebFlux with OpenAPI 3 and Scalar</a></p>
50
50
</li>
51
51
<li>
52
-
<p><ahref="https://demos.springdoc.org/demo-spring-boot-3-webflux-functional/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 3 WebFlux with Functional endpoints OpenAPI 3</a></p>
52
+
<p><ahref="https://demos1.springdoc.org/demo-spring-boot-webflux-functional/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 4 WebFlux with Functional endpoints OpenAPI 3</a></p>
53
53
</li>
54
54
<li>
55
-
<p><ahref="https://demos.springdoc.org/demo-spring-hateoas" target="_blank" rel="noopener">Demo Spring Boot 3 and Spring Hateoas with OpenAPI 3</a></p>
55
+
<p><ahref="https://demos1.springdoc.org/demo-spring-hateoas" target="_blank" rel="noopener">Demo Spring Boot 4 and Spring Hateoas with OpenAPI 3</a></p>
56
56
</li>
57
57
<li>
58
-
<p><ahref="https://demos.springdoc.org/spring-cloud-function-webmvc" target="_blank" rel="noopener">Demo Spring Boot 3 and Spring Cloud Function Web MVC</a></p>
58
+
<p><ahref="https://demos1.springdoc.org/spring-cloud-function-webmvc" target="_blank" rel="noopener">Demo Spring Boot 4 and Spring Cloud Function Web MVC</a></p>
59
59
</li>
60
60
<li>
61
-
<p><ahref="https://demos.springdoc.org/spring-cloud-function-webflux/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 3 and Spring Cloud Function WebFlux</a></p>
61
+
<p><ahref="https://demos1.springdoc.org/spring-cloud-function-webflux/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 4 and Spring Cloud Function WebFlux</a></p>
62
62
</li>
63
63
<li>
64
-
<p><ahref="https://demos.springdoc.org/demo-microservices/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 3 and Spring Cloud Gateway</a></p>
64
+
<p><ahref="https://demos1.springdoc.org/demo-microservices/swagger-ui.html" target="_blank" rel="noopener">Demo Spring Boot 4 and Spring Cloud Gateway</a></p>
65
+
</li>
66
+
<li>
67
+
<p><ahref="https://demos1.springdoc.org/demo-spring-boot-mcp/mcp-ui/index.html" target="_blank" rel="noopener">Demo Spring Boot 4 with MCP Support</a></p>
<h3id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"><aclass="anchor" href="#_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"></a>What is the compatibility matrix of <code>springdoc-openapi</code> with <code>spring-boot</code> ?</h3>
2003
2003
<divclass="paragraph">
2004
-
<p><code>springdoc-openapi 2.x</code> is compatible with <code>spring-boot 3</code>.</p>
2004
+
<p><code>springdoc-openapi 3.x</code> is compatible with <code>spring-boot 4</code>.</p>
2005
2005
</div>
2006
2006
<divclass="paragraph">
2007
-
<p>In general, <strong>you should only pick the last stable version as per today 2.8.17.</strong></p>
2007
+
<p>In general, <strong>you should only pick the last stable version as per today 3.0.3.</strong></p>
2008
2008
</div>
2009
2009
<divclass="paragraph">
2010
2010
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>
0 commit comments