|
| 1 | + |
1 | 2 | [](https://travis-ci.org/springdoc/springdoc-openapi)
|
2 | 3 | [](https://sonarcloud.io/dashboard?id=springdoc_springdoc-openapi)
|
3 | 4 | [](https://snyk.io/test/github/springdoc/springdoc-openapi.git)
|
4 |
| - |
5 |
| - |
| 5 | + |
| 6 | + |
| 7 | +# Table of Contents |
| 8 | +- [Full documentation](#full-documentation) |
| 9 | +- [**Introduction**](#introduction) |
| 10 | +- [**Getting Started**](#getting-started) |
| 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 | +- [Acknowledgements](#acknowledgements) |
| 24 | + - [Contributors](#contributors) |
| 25 | + - [Additional Support](#additional-support) |
6 | 26 |
|
7 | 27 | # [Full documentation](https://springdoc.org)
|
8 | 28 |
|
9 |
| -# Acknowledgements |
10 |
| - |
11 |
| -[springdoc-openapi is made possible thanks to all of its contributors.](https://github.com/springdoc/springdoc-openapi/graphs/contributors) |
12 |
| - |
13 |
| -<a href="https://github.com/springdoc/springdoc-openapi/graphs/contributors"> |
14 |
| - <img src="https://contrib.rocks/image?repo=springdoc/springdoc-openapi" /> |
15 |
| -</a> |
16 |
| - |
17 | 29 | # **Introduction**
|
18 | 30 |
|
19 | 31 | The springdoc-openapi Java library helps automating the generation of API documentation using Spring Boot projects.
|
@@ -60,17 +72,14 @@ This is a community-based project, not maintained by the Spring Framework Contri
|
60 | 72 | springdoc.swagger-ui.path=/swagger-ui.html
|
61 | 73 | ```
|
62 | 74 |
|
63 |
| -## Source code of the Demo Applications |
64 |
| -* [https://github.com/springdoc/springdoc-openapi-demos.git](https://github.com/springdoc/springdoc-openapi-demos.git). |
65 |
| - |
66 |
| - |
67 | 75 | ## Spring-boot with OpenAPI Demo applications.
|
68 | 76 |
|
69 |
| -## [Demo Spring Boot 2 Web MVC with OpenAPI 3](http://158.101.164.60:8081/). |
70 |
| -## [Demo Spring Boot 2 WebFlux with OpenAPI 3](http://158.101.164.60:8082/). |
71 |
| -## [Demo Spring Boot 1 Web MVC with OpenAPI 3](http://158.101.164.60:8083/). |
72 |
| -## [Demo Spring Boot 2 WebFlux with Functional endpoints OpenAPI 3](http://158.101.164.60:8084/swagger-ui.html). |
73 |
| -## [Demo Spring Boot 2 and Spring Hateoas with OpenAPI 3](http://158.101.164.60:8085/swagger-ui.html). |
| 77 | +### [Source Code for Demo Applications](https://github.com/springdoc/springdoc-openapi-demos.git). |
| 78 | +### [Demo Spring Boot 2 Web MVC with OpenAPI 3](http://158.101.164.60:8081/). |
| 79 | +### [Demo Spring Boot 2 WebFlux with OpenAPI 3](http://158.101.164.60:8082/). |
| 80 | +### [Demo Spring Boot 1 Web MVC with OpenAPI 3](http://158.101.164.60:8083/). |
| 81 | +### [Demo Spring Boot 2 WebFlux with Functional endpoints OpenAPI 3](http://158.101.164.60:8084/swagger-ui.html). |
| 82 | +### [Demo Spring Boot 2 and Spring Hateoas with OpenAPI 3](http://158.101.164.60:8085/swagger-ui.html). |
74 | 83 |
|
75 | 84 | 
|
76 | 85 |
|
@@ -138,8 +147,19 @@ Releases:
|
138 | 147 | Snapshots:
|
139 | 148 | * [https://oss.sonatype.org/content/repositories/snapshots/org/springdoc/](https://oss.sonatype.org/content/repositories/snapshots/org/springdoc/).
|
140 | 149 |
|
141 |
| -# **Thank you for the support** |
| 150 | +# Acknowledgements |
| 151 | + |
| 152 | +## Contributors |
| 153 | +springdoc-openapi is relevant and updated regularly due to the valuable contributions from its [contributors](https://github.com/springdoc/springdoc-openapi/graphs/contributors). |
| 154 | + |
| 155 | +<a href="https://github.com/springdoc/springdoc-openapi/graphs/contributors"> |
| 156 | + <img src="https://contrib.rocks/image?repo=springdoc/springdoc-openapi" width="50%"/> |
| 157 | +</a> |
| 158 | + |
| 159 | +Thanks a lot for your support! |
142 | 160 |
|
143 |
| -* Thanks a lot [JetBrains](https://www.jetbrains.com/?from=springdoc-openapi) for supporting springdoc-openapi project. |
| 161 | +## Additional Support |
| 162 | +* [Spring Team](https://spring.io/team) - Thanks for their support by sharing all relevant resources around Spring projects. |
| 163 | +* [JetBrains](https://www.jetbrains.com/?from=springdoc-openapi) - Thanks a lot for supporting springdoc-openapi project. |
144 | 164 |
|
145 | 165 | 
|
0 commit comments