# springdoc-openapi **Repository Path**: f1818/springdoc-openapi ## Basic Information - **Project Name**: springdoc-openapi - **Description**: springdoc镜像（gitee加速）（非官方）同步于：https://github.com/springdoc/springdoc-openapi 官网：https://springdoc.org/ - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: main - **Homepage**: https://springdoc.org/ - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-02-24 - **Last Updated**: 2026-11-03 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README

📘 OpenAPI 3 documentation, Swagger UI and Scalar for Spring Boot, generated from your code

📖 Documentation · 🚀 Getting started · ⚙️ Properties · 🎮 Demos · ❓ FAQ · 📝 Changelog

💖 Sponsored by

_{If you ❤️ springdoc-openapi, become a sponsor: it covers the project expenses and helps it grow.}

--- **springdoc-openapi** examines your Spring Boot application at runtime, its controllers, configuration, validation constraints and annotations, and serves an OpenAPI 3 description in JSON and YAML, together with an interactive Swagger UI or Scalar page. Add one dependency: there is nothing to configure. ✨

Swagger UI generated by springdoc-openapi

## 🚀 Getting started For a Spring Boot 4 web application (Java 17+): ```xml org.springdoc springdoc-openapi-starter-webmvc-ui 3.2.0 ``` Then open 👉 `http://localhost:8080/swagger-ui.html`. The OpenAPI description is served at `/v3/api-docs` (and `/v3/api-docs.yaml`). Using WebFlux, Scalar, or only the API description? Pick another starter in the [getting started guide](https://springdoc.org/getting-started.html). ## 🧭 Compatibility | Spring Boot | springdoc-openapi | Documentation | |:---:|:---:|:---:| | 🍃 4.x | **3.x** (this branch) | [springdoc.org](https://springdoc.org) | | 🍃 3.x | 2.x ([`spring-boot-3` branch](https://github.com/springdoc/springdoc-openapi/tree/spring-boot-3)) | [springdoc.org/v2](https://springdoc.org/v2/) | | 🍂 2.x and 1.x | 1.8.0 (end of open-source support) | [springdoc.org/v1](https://springdoc.org/v1/) | ## ✨ Modules and features - 🌐 [Spring Web MVC](https://springdoc.org/modules.html#_spring_webmvc_support) and [Spring WebFlux](https://springdoc.org/modules.html#_spring_webflux_support), including [functional endpoints](https://springdoc.org/features.html#_spring_webfluxwebmvc_fn_with_functional_endpoints) - 🖥️ [Swagger UI](https://springdoc.org/modules.html#_swagger_ui_support) and [Scalar](https://springdoc.org/modules.html#_scalar_support) user interfaces - 🤖 [MCP support](https://springdoc.org/mcp.html), to expose your API as tools for AI agents - 🔐 [Spring Security](https://springdoc.org/modules.html#_spring_security_support) and OAuth 2 - 🧩 [Spring Data REST](https://springdoc.org/modules.html#_spring_data_rest_support), [Spring HATEOAS](https://springdoc.org/modules.html#_spring_hateoas_support), [Actuator](https://springdoc.org/modules.html#_actuator_support) and [Spring Cloud Function](https://springdoc.org/modules.html#_spring_cloud_function_web_support) - 🧪 [Kotlin](https://springdoc.org/modules.html#_kotlin_support), [Groovy](https://springdoc.org/modules.html#_groovy_support) and [Javadoc](https://springdoc.org/modules.html#_javadoc_support) support - ✅ Bean Validation (`@NotNull`, `@Min`, `@Max`, `@Size`) and ⚡ GraalVM native images - 🛠️ [API information and security schemes](https://springdoc.org/features.html#_adding_api_information_and_security_documentation), [controller selection](https://springdoc.org/features.html#_selecting_the_rest_controllers_to_include_in_the_documentation) and [hundreds of properties](https://springdoc.org/properties.html) - 📦 [Maven and Gradle plugins](https://springdoc.org/plugins.html) to generate the description at build time ## 🎮 Demos Try the [live demos](https://springdoc.org/demos.html), for Web MVC, WebFlux, Scalar, Spring Cloud and MCP. Their source code is in [springdoc-openapi-demos](https://github.com/springdoc/springdoc-openapi-demos/tree/master). ## 💬 Getting help - 📖 Read the [documentation](https://springdoc.org), the [FAQ](https://springdoc.org/faq.html), and the [other resources](https://springdoc.org/other-resources.html) (tutorials and articles) - 🔀 Migrating? See [from SpringFox](https://springdoc.org/migrating-from-springfox.html) or [from springdoc-openapi v1](https://springdoc.org/migrating-from-springdoc-v1.html) - 🙋 Ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/springdoc) with the `springdoc` tag - 🐛 Report bugs in [GitHub issues](https://github.com/springdoc/springdoc-openapi/issues), with a minimal reproducer - 🔒 Report vulnerabilities privately, following the [security policy](SECURITY.md) > [!NOTE] > springdoc-openapi is a community project, not maintained by the Spring team. ## 🤝 Contributing Contributions are welcome! See [CONTRIBUTING.adoc](CONTRIBUTING.adoc) and the [Code of Conduct](CODE_OF_CONDUCT.md). Thanks to all our [contributors](https://github.com/springdoc/springdoc-openapi/graphs/contributors) 🙏

Special thanks to [the Spring team](https://spring.io/team) and [JetBrains](https://www.jetbrains.com/?from=springdoc-openapi) for their support.

## 📄 License springdoc-openapi is Open Source software released under the [Apache 2.0 license](LICENSE).