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
-[Library for springdoc-openapi integration with spring-boot and swagger-ui](#library-for-springdoc-openapi-integration-with-spring-boot-and-swagger-ui)
12
-
-[Spring-boot with OpenAPI Demo applications.](#spring-boot-with-openapi-demo-applications)
13
-
-[Source Code for Demo Applications.](#source-code-for-demo-applications)
14
-
-[Demo Spring Boot 2 Web MVC with OpenAPI 3.](#demo-spring-boot-2-web-mvc-with-openapi-3)
15
-
-[Demo Spring Boot 2 WebFlux with OpenAPI 3.](#demo-spring-boot-2-webflux-with-openapi-3)
16
-
-[Demo Spring Boot 1 Web MVC with OpenAPI 3.](#demo-spring-boot-1-web-mvc-with-openapi-3)
17
-
-[Demo Spring Boot 2 WebFlux with Functional endpoints OpenAPI 3.](#demo-spring-boot-2-webflux-with-functional-endpoints-openapi-3)
18
-
-[Demo Spring Boot 2 and Spring Hateoas with OpenAPI 3.](#demo-spring-boot-2-and-spring-hateoas-with-openapi-3)
19
-
-[Integration of the library in a Spring Boot 2.x.x project without the swagger-ui:](#integration-of-the-library-in-a-spring-boot-2xx-project-without-the-swagger-ui)
20
-
-[Error Handling for REST using @ControllerAdvice](#error-handling-for-rest-using-controlleradvice)
21
-
-[Adding API Information and Security documentation](#adding-api-information-and-security-documentation)
22
-
-[spring-webflux support with Annotated Controllers](#spring-webflux-support-with-annotated-controllers)
11
+
-[Library for springdoc-openapi integration with spring-boot and swagger-ui](#library-for-springdoc-openapi-integration-with-spring-boot-and-swagger-ui)
12
+
-[Spring-boot with OpenAPI Demo applications.](#spring-boot-with-openapi-demo-applications)
13
+
-[Source Code for Demo Applications.](#source-code-for-demo-applications)
14
+
-[Demo Spring Boot 2 Web MVC with OpenAPI 3.](#demo-spring-boot-2-web-mvc-with-openapi-3)
15
+
-[Demo Spring Boot 2 WebFlux with OpenAPI 3.](#demo-spring-boot-2-webflux-with-openapi-3)
16
+
-[Demo Spring Boot 1 Web MVC with OpenAPI 3.](#demo-spring-boot-1-web-mvc-with-openapi-3)
17
+
-[Demo Spring Boot 2 WebFlux with Functional endpoints OpenAPI 3.](#demo-spring-boot-2-webflux-with-functional-endpoints-openapi-3)
18
+
-[Demo Spring Boot 2 and Spring Hateoas with OpenAPI 3.](#demo-spring-boot-2-and-spring-hateoas-with-openapi-3)
19
+
-[Integration of the library in a Spring Boot 2.x.x project without the swagger-ui:](#integration-of-the-library-in-a-spring-boot-2xx-project-without-the-swagger-ui)
20
+
-[Error Handling for REST using @ControllerAdvice](#error-handling-for-rest-using-controlleradvice)
21
+
-[Adding API Information and Security documentation](#adding-api-information-and-security-documentation)
22
+
-[spring-webflux support with Annotated Controllers](#spring-webflux-support-with-annotated-controllers)
23
23
-[Acknowledgements](#acknowledgements)
24
-
-[Contributors](#contributors)
25
-
-[Additional Support](#additional-support)
24
+
-[Contributors](#contributors)
25
+
-[Additional Support](#additional-support)
26
26
27
27
# [Full documentation](https://springdoc.org)
28
28
@@ -48,20 +48,20 @@ This is a community-based project, not maintained by the Spring Framework Contri
48
48
49
49
# **Getting Started**
50
50
51
-
## Library for springdoc-openapi integration with spring-boot and swagger-ui
51
+
## Library for springdoc-openapi integration with spring-boot and swagger-ui
52
52
* Automatically deploys swagger-ui to a Spring Boot 2.x application
53
53
* Documentation will be available in HTML format, using the official [swagger-ui jars](https://github.com/swagger-api/swagger-ui.git).
54
54
* The Swagger UI page should then be available at http://server:port/context-path/swagger-ui.html and the OpenAPI description will be available at the following url for json format: http://server:port/context-path/v3/api-docs
55
55
*`server`: The server name or IP
56
56
*`port`: The server port
57
57
*`context-path`: The context path of the application
58
58
* Documentation can be available in yaml format as well, on the following path: /v3/api-docs.yaml
59
-
* Add the `springdoc-openapi-starter-webmvc-ui` library to the list of your project dependencies (No additional configuration is needed):
59
+
* Add the `springdoc-openapi-ui` library to the list of your project dependencies (No additional configuration is needed):
* This step is optional: For custom path of the swagger documentation in HTML format, add a custom springdoc property, in your spring-boot configuration file:
135
135
@@ -138,7 +138,7 @@ To generate documentation automatically, make sure all the methods declare the H
138
138
springdoc.swagger-ui.path=/swagger-ui.html
139
139
```
140
140
141
-
The `springdoc-openapi` libraries are hosted on maven central repository.
141
+
The `springdoc-openapi` libraries are hosted on maven central repository.
142
142
The artifacts can be viewed accessed at the following locations:
0 commit comments