Skip to content

Commit

Permalink
Merge pull request #2549 from zinzoddari/fix-readme
Browse files Browse the repository at this point in the history
Fix README.md
  • Loading branch information
bnasslahsen committed Mar 27, 2024
2 parents f87c7b9 + 67c83ae commit eedce11
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
[![Known Vulnerabilities](https://snyk.io/test/github/springdoc/springdoc-openapi.git/badge.svg)](https://snyk.io/test/github/springdoc/springdoc-openapi.git)
[![Stack Exchange questions](https://img.shields.io/stackexchange/stackoverflow/t/springdoc)](https://stackoverflow.com/questions/tagged/springdoc?tab=Votes)

IMPORTANT: ``springdoc-openapi v1.7.0 `` is the latest Open Source release supporting Spring Boot 2.x and 1.x.
IMPORTANT: ``springdoc-openapi v1.8.0`` is the latest Open Source release supporting Spring Boot 2.x and 1.x.

An extended support for [*springdoc-openapi v1*](https://springdoc.org/v1)
project is now available for organizations that need support beyond 2023.

For more details, feel free to reach out: sales@springdoc.org
For more details, feel free to reach out: [sales@springdoc.org](mailto:sales@springdoc.org)

If you ❤️ this project consider becoming
``springdoc-openapi`` is on [Open Collective](https://opencollective.com/springdoc). If you ❤️ this project consider becoming
a [sponsor](https://github.com/sponsors/springdoc).

This project is sponsored by
Expand Down Expand Up @@ -41,7 +41,6 @@ This project is sponsored by
- [Source Code for Demo Applications.](#source-code-for-demo-applications)
- [Demo Spring Boot 2 Web MVC with OpenAPI 3.](#demo-spring-boot-2-web-mvc-with-openapi-3)
- [Demo Spring Boot 2 WebFlux with OpenAPI 3.](#demo-spring-boot-2-webflux-with-openapi-3)
- [Demo Spring Boot 1 Web MVC with OpenAPI 3.](#demo-spring-boot-1-web-mvc-with-openapi-3)
- [Demo Spring Boot 2 WebFlux with Functional endpoints OpenAPI 3.](#demo-spring-boot-2-webflux-with-functional-endpoints-openapi-3)
- [Demo Spring Boot 2 and Spring Hateoas with OpenAPI 3.](#demo-spring-boot-2-and-spring-hateoas-with-openapi-3)
- [Integration of the library in a Spring Boot 3.x project without the swagger-ui:](#integration-of-the-library-in-a-spring-boot-3x-project-without-the-swagger-ui)
Expand Down Expand Up @@ -79,8 +78,7 @@ The following video introduces the Library:

For *spring-boot v3* support, make sure you use [springdoc-openapi v2](https://springdoc.org/)

This is a community-based project, not maintained by the Spring Framework Contributors (
Pivotal)
This is a community-based project, not maintained by the Spring Framework Contributors (Pivotal)

# **Getting Started**

Expand All @@ -96,7 +94,7 @@ Pivotal)
* `port`: The server port
* `context-path`: The context path of the application
* Documentation can be available in yaml format as well, on the following path:
/v3/api-docs.yaml
`/v3/api-docs.yaml`
* Add the `springdoc-openapi-ui` library to the list of your project dependencies (No
additional configuration is needed):

Expand Down Expand Up @@ -184,15 +182,15 @@ and `@SecurityScheme` annotations within a Spring managed bean.

* Documentation can be available in yaml format as well, on the following path :
/v3/api-docs.yaml
* Add the library to the list of your project dependencies ( No additional configuration
* Add the library to the list of your project dependencies (No additional configuration
is needed)

```xml
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
<version>last-release-version</version>
</dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
<version>last-release-version</version>
</dependency>
```

* This step is optional: For custom path of the swagger documentation in HTML format, add
Expand Down

0 comments on commit eedce11

Please sign in to comment.