{"repo":"springdoc/springdoc-openapi","free":true,"listed":false,"github":"https://github.com/springdoc/springdoc-openapi","clone":"git clone https://github.com/springdoc/springdoc-openapi.git","description":"Library for OpenAPI 3 with spring-boot","language":"Java","stars":3733,"topics":["openapi3","spring-boot","springdoc-openapi","swagger-ui","swagger-documentation","openapi","openapi-specification","swagger","yaml-format","json-format"],"license":"Apache-2.0","category":"api-integrations-sdks","readme_excerpt":"springdoc-openapi is on Open Collective. If you ❤️ this project consider becoming a sponsor. This project is sponsored by    Table of Contents - Full documentation - Introduction - Getting Started - Library for springdoc-openapi integration with spring-boot and swagger-ui - Spring-boot with OpenAPI Demo applications. - Source Code for Demo Applications. - Demo Spring Boot 4 Web MVC with OpenAPI 3. - Demo Spring Boot 4 WebFlux with OpenAPI 3. - Demo Spring Boot 4 WebFlux with Functional endpoints OpenAPI 3. - Demo Spring Boot 4 and Spring Hateoas with OpenAPI 3. - Integration of the library in a Spring Boot 4.x project without the swagger-ui: - Error Handling for REST using @ControllerAdvice - Adding API Information and Security documentation - spring-webflux support with Annotated Controllers - Using a separate management port (Spring Boot 4) - When Spring Security is enabled - Acknowledgements - Contributors - Additional Support Full documentation Introduction The springdoc-openapi Java library helps automating the generation of API documentation using Spring Boot projects. springdoc-openapi works by examining an application at runtime to infer API semantics based on Spring configurations, class structure and various annotations. The library automatically generates documentation in JSON/YAML and HTML formatted pages. The generated documentation can be complemented using swagger-api annotations. This library supports: OpenAPI 3 Spring-boot v4 (Java 17 & Jakarta EE 9","default_branch":null,"files":null,"tree":[],"storefront":"/r/springdoc","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/springdoc/springdoc-openapi/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}