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