springdoc.org

Website review springdoc.org

OpenAPI 3 Library for spring-boot

 Generated on March 17 2026 08:08 AM

Old data? UPDATE !

The score is 49/100

SEO Content

Title

OpenAPI 3 Library for spring-boot

Length : 33

Perfect, your title contains between 10 and 70 characters.

Description

OpenAPI 3 Library for spring boot projects. Is based on swagger-ui, to display the OpenAPI description.Generates automatically the OpenAPI file.

Length : 144

Great, your meta description contains between 70 and 160 characters.

Keywords

Very bad. We haven't found meta keywords on your page. Use this free online meta tags generator to create keywords.

Og Meta Properties

Good, your page take advantage of Og Properties.

Property Content
title OpenAPI 3 Library for spring-boot
locale en_US
description Library for OpenAPI 3 with spring boot projects. Is based on swagger-ui, to display the OpenAPI description.Generates automatically the OpenAPI file.
url http://springdoc.org/
site_name OpenAPI 3 Library for spring-boot
image https://springdoc.org/img/banner-logo.svg

Headings

H1 H2 H3 H4 H5 H6
1 13 114 0 0 0
  • [H1] springdoc-openapi v2.8.16
  • [H2] 1. Introduction
  • [H2] 2. Getting Started
  • [H2] 3. Springdoc-openapi Modules
  • [H2] 4. Springdoc-openapi Features
  • [H2] 5. Springdoc-openapi Properties
  • [H2] 6. Springdoc-openapi Plugins
  • [H2] 7. Springdoc-openapi Demos
  • [H2] 8. Migrating from springdoc-openapi v1
  • [H2] 9. Migrating from SpringFox
  • [H2] 10. Other resources
  • [H2] 11. Sponsor
  • [H2] 12. Special Thanks
  • [H2] 13. F.A.Q
  • [H3] 3.1. General overview
  • [H3] 3.2. Spring WebMvc support
  • [H3] 3.3. Spring WebFlux support
  • [H3] 3.4. Swagger-UI support
  • [H3] 3.5. Scalar support
  • [H3] 3.6. Spring Hateoas support
  • [H3] 3.7. Spring Data Rest support
  • [H3] 3.8. Spring Security support
  • [H3] 3.9. Actuator support
  • [H3] 3.10. Spring Cloud Function Web support
  • [H3] 3.11. Kotlin support
  • [H3] 3.12. Groovy support
  • [H3] 3.13. Javadoc support
  • [H3] 3.14. Springdoc-openapi BOM
  • [H3] 4.1. Adding API Information and Security documentation
  • [H3] 4.2. Error Handling for REST using @ControllerAdvice
  • [H3] 4.3. Disabling the springdoc-openapi endpoints
  • [H3] 4.4. Disabling the swagger-ui
  • [H3] 4.5. Swagger-ui configuration
  • [H3] 4.6. Selecting the Rest Controllers to include in the documentation
  • [H3] 4.7. Spring-webflux/WebMvc.fn with Functional Endpoints
  • [H3] 4.8. Integration with WildFly
  • [H3] 5.1. springdoc-openapi core properties
  • [H3] 5.2. swagger-ui properties
  • [H3] 6.1. Maven plugin
  • [H3] 6.2. Gradle plugin
  • [H3] 7.1. springdoc applications demos
  • [H3] 7.2. Source code of the Demo Applications
  • [H3] 10.1. Additional resources to get started
  • [H3] 10.2. Dependencies repository
  • [H3] 11.1. Benefits of being a bronze sponsor
  • [H3] 11.2. Benefits of being a silver sponsor
  • [H3] 11.3. Benefits of being a gold sponsor
  • [H3] 13.1. How can I define multiple OpenAPI definitions in one Spring Boot project?
  • [H3] 13.2. How can I configure Swagger UI?
  • [H3] 13.3. How can I filter the resources documented in the output specification by the provided group?
  • [H3] 13.4. How can I disable/enable Swagger UI generation based on env variable?
  • [H3] 13.5. How can I control the default expansion setting for the operations and tags, in the Swagger UI ,
  • [H3] 13.6. How can I change the layout of the swagger-ui?
  • [H3] 13.7. How can I sort endpoints alphabetically?
  • [H3] 13.8. How can I disable the try it out button?
  • [H3] 13.9. How can I add Reusable Enums ?
  • [H3] 13.10. How can i apply enumAsRef = true to all enums ?
  • [H3] 13.11. How can I explicitly set which paths to filter?
  • [H3] 13.12. How can I explicitly set which packages to scan?
  • [H3] 13.13. How can I set Swagger properties programmatically?
  • [H3] 13.14. How can I ignore some field of model ?
  • [H3] 13.15. How can I ignore @AuthenticationPrincipal parameter from spring-security ?
  • [H3] 13.16. Is there a Gradle plugin available?
  • [H3] 13.17. How can I hide a parameter from the documentation ?
  • [H3] 13.18. Is @Parameters annotation supported ?
  • [H3] 13.19. Does springdoc-openapi support Jersey?
  • [H3] 13.20. Can springdoc-openapi generate API only for @RestController?
  • [H3] 13.21. Are the following validation annotations supported : @NotEmpty @NotBlank @PositiveOrZero @NegativeOrZero?
  • [H3] 13.22. How can I map Pageable (spring-data-commons) object to correct URL-Parameter in Swagger UI?
  • [H3] 13.23. How can I generate enums in the generated description?
  • [H3] 13.24. How can I deploy springdoc-openapi-starter-webmvc-ui behind a reverse proxy?
  • [H3] 13.25. Is @JsonView annotations in Spring MVC APIs supported?
  • [H3] 13.26. Adding springdoc-openapi-starter-webmvc-ui dependency breaks my public/index.html welcome page
  • [H3] 13.27. How can I test the Swagger UI?
  • [H3] 13.28. How can I customise the OpenAPI object ?
  • [H3] 13.29. How can I return an empty content as response?
  • [H3] 13.30. How are endpoints with multiple consuming media types supported?
  • [H3] 13.31. How can I get yaml and json (OpenAPI) in compile time?
  • [H3] 13.32. What are the ignored types in the documentation?
  • [H3] 13.33. How can i disable ignored types:
  • [H3] 13.34. How do I add authorization header in requests?
  • [H3] 13.35. Differentiation to Springfox project
  • [H3] 13.36. How do I migrate to OpenAPI 3 with springdoc-openapi
  • [H3] 13.37. How can I set a global header?
  • [H3] 13.38. Are Callbacks supported?
  • [H3] 13.39. How can I define SecurityScheme ?
  • [H3] 13.40. How can I hide an operation or a controller from documentation ?
  • [H3] 13.41. How to configure global security schemes?
  • [H3] 13.42. Can I use spring property with swagger annotations?
  • [H3] 13.43. How is server URL generated ?
  • [H3] 13.44. How can I disable springdoc-openapi cache?
  • [H3] 13.45. How can I expose the mvc api-docs endpoints without using the swagger-ui?
  • [H3] 13.46. How can I disable springdoc-openapi endpoints ?
  • [H3] 13.47. How can I hide Schema of the the response ?
  • [H3] 13.48. What is the URL of the swagger-ui, when I set a different context-path?
  • [H3] 13.49. Can I customize OpenAPI object programmatically?
  • [H3] 13.50. Where can I find the source code of the demo applications?
  • [H3] 13.51. Does this library supports annotations from interfaces?
  • [H3] 13.52. What is the list of the excluded parameter types?
  • [H3] 13.53. Is file upload supported ?
  • [H3] 13.54. Can I use @Parameter inside @Operation annotation?
  • [H3] 13.55. Why my parameter is marked as required?
  • [H3] 13.56. How are overloaded methods with the same endpoints, but with different parameters
  • [H3] 13.57. What is a proper way to set up Swagger UI to use provided spec.yml?
  • [H3] 13.58. Is there a way to send authorization header through the @Parameter tag?
  • [H3] 13.59. My Rest Controller using @Controller annotation is ignored?
  • [H3] 13.60. How can I define groups using application.yml?
  • [H3] 13.61. How can I extract fields from parameter object ?
  • [H3] 13.62. How can I use the last springdoc-openapi SNAPSHOT ?
  • [H3] 13.63. How can I use enable springdoc-openapi MonetaryAmount support ?
  • [H3] 13.64. How can i aggregate external endpoints (exposing OPENAPI 3 spec) inside one single application?
  • [H3] 13.65. How can use custom json/yml file instead of generated one ?
  • [H3] 13.66. How can i enable CSRF support?
  • [H3] 13.67. How can i disable the default swagger petstore URL?
  • [H3] 13.68. Is @PageableDefault supported, to enhance the OpenAPI 3 docuementation?
  • [H3] 13.69. How can i make spring security login-endpoint visible ?
  • [H3] 13.70. How can i show schema definitions even the schema is not referenced?
  • [H3] 13.71. How to override @Deprecated?
  • [H3] 13.72. How can i display a method that returns ModelAndView?
  • [H3] 13.73. How can i have pretty-printed output of the OpenApi specification?
  • [H3] 13.74. How can i define different schemas for the same class?
  • [H3] 13.75. How can i define different description for a class attribute depending on usage?
  • [H3] 13.76. Customizing swagger static resources
  • [H3] 13.77. Is GraalVM supported ?
  • [H3] 13.78. How to Integrate Open API 3 with Spring project (not Spring Boot)?
  • [H3] 13.79. What is the compatibility matrix of springdoc-openapi with spring-boot ?
  • [H3] 13.80. Why am i getting an error: Swagger UI unable to render definition, when overriding the default spring registered HttpMessageConverter?
  • [H3] 13.81. Some parameters are not generated in the resulting OpenAPI spec.

Images

We found 17 images on this web page.

10 alt attributes are empty or missing. Add alternative text so that search engines can better understand the content of your images.

Text/HTML Ratio

Ratio : 0%

This page's ratio of text to HTML code is below 15 percent, this means that your website probably needs more text content.

Flash

Perfect, no Flash content has been detected on this page.

Iframe

Great, there are no Iframes detected on this page.

URL Rewrite

Good. Your links looks friendly!

Underscores in the URLs

Perfect! No underscores detected in your URLs.

In-page links

We found a total of 188 links including 11 link(s) to files

Anchor Type Juice
1. Introduction Internal Passing Juice
2. Getting Started Internal Passing Juice
3. Springdoc-openapi Modules Internal Passing Juice
3.1. General overview Internal Passing Juice
3.2. Spring WebMvc support Internal Passing Juice
3.3. Spring WebFlux support Internal Passing Juice
3.4. Swagger-UI support Internal Passing Juice
3.5. Scalar support Internal Passing Juice
3.6. Spring Hateoas support Internal Passing Juice
3.7. Spring Data Rest support Internal Passing Juice
3.8. Spring Security support Internal Passing Juice
3.9. Actuator support Internal Passing Juice
3.10. Spring Cloud Function Web support Internal Passing Juice
3.11. Kotlin support Internal Passing Juice
3.12. Groovy support Internal Passing Juice
3.13. Javadoc support Internal Passing Juice
3.14. Springdoc-openapi BOM Internal Passing Juice
4. Springdoc-openapi Features Internal Passing Juice
4.1. Adding API Information and Security documentation Internal Passing Juice
4.2. Error Handling for REST using @ControllerAdvice Internal Passing Juice
4.4. Disabling the swagger-ui Internal Passing Juice
4.5. Swagger-ui configuration Internal Passing Juice
4.6. Selecting the Rest Controllers to include in the documentation Internal Passing Juice
4.7. Spring-webflux/WebMvc.fn with Functional Endpoints Internal Passing Juice
4.8. Integration with WildFly Internal Passing Juice
5. Springdoc-openapi Properties Internal Passing Juice
5.1. springdoc-openapi core properties Internal Passing Juice
5.2. swagger-ui properties Internal Passing Juice
6. Springdoc-openapi Plugins Internal Passing Juice
6.1. Maven plugin Internal Passing Juice
6.2. Gradle plugin Internal Passing Juice
7. Springdoc-openapi Demos Internal Passing Juice
7.1. springdoc applications demos Internal Passing Juice
7.2. Source code of the Demo Applications Internal Passing Juice
8. Migrating from springdoc-openapi v1 Internal Passing Juice
9. Migrating from SpringFox Internal Passing Juice
10. Other resources Internal Passing Juice
10.1. Additional resources to get started Internal Passing Juice
10.2. Dependencies repository Internal Passing Juice
11. Sponsor Internal Passing Juice
11.1. Benefits of being a bronze sponsor Internal Passing Juice
11.2. Benefits of being a silver sponsor Internal Passing Juice
11.3. Benefits of being a gold sponsor Internal Passing Juice
12. Special Thanks Internal Passing Juice
13. F.A.Q Internal Passing Juice
13.1. How can I define multiple OpenAPI definitions in one Spring Boot project? Internal Passing Juice
13.2. How can I configure Swagger UI? Internal Passing Juice
13.3. How can I filter the resources documented in the output specification by the provided group? Internal Passing Juice
13.4. How can I disable/enable Swagger UI generation based on env variable? Internal Passing Juice
13.5. How can I control the default expansion setting for the operations and tags, in the Swagger UI , Internal Passing Juice
13.7. How can I sort endpoints alphabetically? Internal Passing Juice
13.8. How can I disable the try it out button? Internal Passing Juice
13.9. How can I add Reusable Enums ? Internal Passing Juice
13.11. How can I explicitly set which paths to filter? Internal Passing Juice
13.12. How can I explicitly set which packages to scan? Internal Passing Juice
13.13. How can I set Swagger properties programmatically? Internal Passing Juice
13.14. How can I ignore some field of model ? Internal Passing Juice
13.16. Is there a Gradle plugin available? Internal Passing Juice
13.17. How can I hide a parameter from the documentation ? Internal Passing Juice
13.23. How can I generate enums in the generated description? Internal Passing Juice
13.27. How can I test the Swagger UI? Internal Passing Juice
13.28. How can I customise the OpenAPI object ? Internal Passing Juice
13.29. How can I return an empty content as response? Internal Passing Juice
13.30. How are endpoints with multiple consuming media types supported? Internal Passing Juice
13.31. How can I get yaml and json (OpenAPI) in compile time? Internal Passing Juice
13.32. What are the ignored types in the documentation? Internal Passing Juice
13.33. How can i disable ignored types: Internal Passing Juice
13.34. How do I add authorization header in requests? Internal Passing Juice
13.35. Differentiation to Springfox project Internal Passing Juice
13.36. How do I migrate to OpenAPI 3 with springdoc-openapi Internal Passing Juice
13.37. How can I set a global header? Internal Passing Juice
13.38. Are Callbacks supported? Internal Passing Juice
13.39. How can I define SecurityScheme ? Internal Passing Juice
13.40. How can I hide an operation or a controller from documentation ? Internal Passing Juice
13.41. How to configure global security schemes? Internal Passing Juice
13.42. Can I use spring property with swagger annotations? Internal Passing Juice
13.43. How is server URL generated ? Internal Passing Juice
13.44. How can I disable springdoc-openapi cache? Internal Passing Juice
13.47. How can I hide Schema of the the response ? Internal Passing Juice
13.49. Can I customize OpenAPI object programmatically? Internal Passing Juice
13.50. Where can I find the source code of the demo applications? Internal Passing Juice
13.51. Does this library supports annotations from interfaces? Internal Passing Juice
13.52. What is the list of the excluded parameter types? Internal Passing Juice
13.53. Is file upload supported ? Internal Passing Juice
13.55. Why my parameter is marked as required? Internal Passing Juice
13.56. How are overloaded methods with the same endpoints, but with different parameters Internal Passing Juice
13.57. What is a proper way to set up Swagger UI to use provided spec.yml? Internal Passing Juice
13.58. Is there a way to send authorization header through the @Parameter tag? Internal Passing Juice
13.59. My Rest Controller using @Controller annotation is ignored? Internal Passing Juice
13.60. How can I define groups using application.yml? Internal Passing Juice
13.61. How can I extract fields from parameter object ? Internal Passing Juice
13.64. How can i aggregate external endpoints (exposing OPENAPI 3 spec) inside one single application? Internal Passing Juice
13.65. How can use custom json/yml file instead of generated one ? Internal Passing Juice
13.66. How can i enable CSRF support? Internal Passing Juice
13.67. How can i disable the default swagger petstore URL? Internal Passing Juice
13.68. Is @PageableDefault supported, to enhance the OpenAPI 3 docuementation? Internal Passing Juice
13.69. How can i make spring security login-endpoint visible ? Internal Passing Juice
13.70. How can i show schema definitions even the schema is not referenced? Internal Passing Juice
13.71. How to override @Deprecated? Internal Passing Juice
13.72. How can i display a method that returns ModelAndView? Internal Passing Juice
13.73. How can i have pretty-printed output of the OpenApi specification? Internal Passing Juice
13.74. How can i define different schemas for the same class? Internal Passing Juice
13.75. How can i define different description for a class attribute depending on usage? Internal Passing Juice
13.76. Customizing swagger static resources Internal Passing Juice
13.77. Is GraalVM supported ? Internal Passing Juice
13.78. How to Integrate Open API 3 with Spring project (not Spring Boot)? Internal Passing Juice
13.81. Some parameters are not generated in the resulting OpenAPI spec. Internal Passing Juice
Open Collective External Passing Juice
sponsor External Passing Juice
View project on GitHub External Passing Juice
swagger-ui jars External Passing Juice
Swagger UI External Passing Juice
Scalar External Passing Juice
Scalar documentation External Passing Juice
Sample applications with Spring Cloud Function Web External Passing Juice
- Internal Passing Juice
https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/ External Passing Juice
#25938 External Passing Juice
HelloRouter External Passing Juice
QuotesRouter External Passing Juice
BookRouter External Passing Juice
EmployeeRouter External Passing Juice
PositionRouter External Passing Juice
Sample webflux application using functional DSL External Passing Juice
Sample code with Functional Endpoints documentation External Passing Juice
spring configuration properties External Passing Juice
see Array.prototype.sort() External Passing Juice
swagger.io/docs/open-source-tools/swagger-ui/usage/deep-linking External Passing Juice
See security advisory External Passing Juice
Highlight.js External Passing Juice
https://github.com/springdoc/springdoc-openapi-maven-plugin External Passing Juice
https://github.com/springdoc/springdoc-openapi-gradle-plugin External Passing Juice
Demo Spring Boot 3 Web MVC with OpenAPI 3 and Swagger-UI Internal Passing Juice
Demo Spring Boot 3 WebFlux with OpenAPI 3 and Swagger-UI Internal Passing Juice
Demo Spring Boot 3 Web MVC with OpenAPI 3 and Scalar Internal Passing Juice
Demo Spring Boot 3 WebFlux with OpenAPI 3 and Scalar Internal Passing Juice
Demo Spring Boot 3 WebFlux with Functional endpoints OpenAPI 3 Internal Passing Juice
Demo Spring Boot 3 and Spring Hateoas with OpenAPI 3 Internal Passing Juice
Demo Spring Boot 3 and Spring Cloud Function Web MVC Internal Passing Juice
Demo Spring Boot 3 and Spring Cloud Function WebFlux Internal Passing Juice
Demo Spring Boot 3 and Spring Cloud Gateway Internal Passing Juice
https://github.com/springdoc/springdoc-openapi-demos/tree/master External Passing Juice
how-can-i-deploy-springdoc-openapi-starter-webmvc-ui-behind-a-reverse-proxy Internal Passing Juice
how-can-i-configure-swagger-ui Internal Passing Juice
how-can-i-hide-an-operation-or-a-controller-from-documentation Internal Passing Juice
Springdoc-openapi presentation External Passing Juice
Baeldung External Passing Juice
DZone Part1 External Passing Juice
DZone Part2 External Passing Juice
Extending Swagger and Spring Doc Open API External Passing Juice
Piotrminkowski Blog External Passing Juice
https://central.sonatype.com/search?q=g:org.springdoc External Passing Juice
https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/org/springdoc/ External Passing Juice
springdoc.org Internal Passing Juice
The Spring Team External Passing Juice
JetBrains External Passing Juice
https://github.com/springdoc/springdoc-openapi/tree/main/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app68 External Passing Juice
- Internal Passing Juice
- Internal Passing Juice
- Internal Passing Juice
gradle plugin Internal Passing Juice
- Internal Passing Juice
- Internal Passing Juice
https://github.com/swagger-api/swagger-samples/tree/2.0/java/java-jersey2-minimal External Passing Juice
- Internal Passing Juice
- Internal Passing Juice
- Internal Passing Juice
- Internal Passing Juice
RFC7239 "Forwarded Headers" External Passing Juice
- Internal Passing Juice
- Internal Passing Juice
https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java External Passing Juice
https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java External Passing Juice
https://github.com/springdoc/springdoc-openapi-maven-plugin.git External Passing Juice
https://docs.spring.io/spring/docs/5.1.x/spring-framework-reference/web.html#mvc-ann-arguments External Passing Juice
- Internal Passing Juice
- Internal Passing Juice
- Internal Passing Juice
https://github.com/springdoc/springdoc-openapi-demos External Passing Juice
- Internal Passing Juice
https://swagger.io/docs/specification/describing-parameters/#header-parameters External Passing Juice
springdoc-openapi-properties Internal Passing Juice
- Internal Passing Juice
- Internal Passing Juice
https://github.com/swagger-api/swagger-ui/blob/main/docs/usage/configuration.md#requestinterceptor External Passing Juice
- Internal Passing Juice
- Internal Passing Juice
Spring-Boot 3.2.0 External Passing Juice

SEO Keywords

Keywords Cloud

Keywords Consistency

Keyword Content Title Keywords Description Headings

Usability

Url

Domain : springdoc.org

Length : 13

Favicon

Great, your website has a favicon.

Printability

We could not find a Print-Friendly CSS.

Language

Good. Your declared language is en.

Dublin Core

This page does not take advantage of Dublin Core.

Document

Doctype

HTML 5

Encoding

Perfect. Your declared charset is UTF-8.

W3C Validity

Errors : 0

Warnings : 0

Email Privacy

Warning! At least one email address has been found in the plain text. Use free antispam protector to hide email from spammers.

Deprecated HTML

Great! We haven't found deprecated HTML tags in your HTML.

Speed Tips

Attention! Try to avoid nested tables in HTML.
Too bad, your website is using inline styles.
Great, your website has few CSS files.
Too bad, your website has too many JS files (more than 6).
Perfect, your website takes advantage of gzip.

Mobile

Mobile Optimization

Apple Icon
Meta Viewport Tag
Flash content

Optimization

XML Sitemap

Great, your website has an XML sitemap.

https://springdoc.org/sitemap.xml

Robots.txt

https://springdoc.org/robots.txt

Great, your website has a robots.txt file.

Analytics

Great, your website has an analytics tool.

   Google Analytics

PageSpeed Insights

Device
Categories

Free SEO Testing Tool

Free SEO Testing Tool is a free SEO tool which provides you content analysis of the website.