Skip to content

Commit baedbec

Browse files
committed
Changes report: Update README.md
1 parent ba22b37 commit baedbec

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

README.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
![Octocat](https://springdoc.org/images/springdoc-openapi.png)
2-
[![Build Status](http://129.159.254.115:8080/buildStatus/icon?job=springdoc-openapi-IC)](http://129.159.254.115:8080/view/springdoc-openapi/job/springdoc-openapi-IC/)
2+
[![Build Status](http://129.159.254.115:8686/buildStatus/icon?job=springdoc-openapi-starter-IC)](http://129.159.254.115:8080/view/springdoc-openapi/job/springdoc-openapi-IC/)
33
[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=springdoc_springdoc-openapi&metric=alert_status)](https://sonarcloud.io/dashboard?id=springdoc_springdoc-openapi)
44
[![Known Vulnerabilities](https://snyk.io/test/github/springdoc/springdoc-openapi.git/badge.svg)](https://snyk.io/test/github/springdoc/springdoc-openapi.git)
55
[![Stack Exchange questions](https://img.shields.io/stackexchange/stackoverflow/t/springdoc)](https://stackoverflow.com/questions/tagged/springdoc?tab=Votes)
@@ -8,21 +8,21 @@
88
- [Full documentation](#full-documentation)
99
- [**Introduction**](#introduction)
1010
- [**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)
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)
2323
- [Acknowledgements](#acknowledgements)
24-
- [Contributors](#contributors)
25-
- [Additional Support](#additional-support)
24+
- [Contributors](#contributors)
25+
- [Additional Support](#additional-support)
2626

2727
# [Full documentation](https://springdoc.org)
2828

@@ -48,20 +48,20 @@ This is a community-based project, not maintained by the Spring Framework Contri
4848

4949
# **Getting Started**
5050

51-
## Library for springdoc-openapi integration with spring-boot and swagger-ui
51+
## Library for springdoc-openapi integration with spring-boot and swagger-ui
5252
* Automatically deploys swagger-ui to a Spring Boot 2.x application
5353
* Documentation will be available in HTML format, using the official [swagger-ui jars](https://github.com/swagger-api/swagger-ui.git).
5454
* 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
5555
* `server`: The server name or IP
5656
* `port`: The server port
5757
* `context-path`: The context path of the application
5858
* 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):
6060

6161
```xml
6262
<dependency>
6363
<groupId>org.springdoc</groupId>
64-
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
64+
<artifactId>springdoc-openapi-ui</artifactId>
6565
<version>last-release-version</version>
6666
</dependency>
6767
```
@@ -94,7 +94,7 @@ springdoc.swagger-ui.path=/swagger-ui.html
9494
```xml
9595
<dependency>
9696
<groupId>org.springdoc</groupId>
97-
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
97+
<artifactId>springdoc-openapi-webmvc-core</artifactId>
9898
<version>last-release-version</version>
9999
</dependency>
100100
```
@@ -111,25 +111,25 @@ springdoc.api-docs.path=/api-docs
111111
# disable api-docs
112112
springdoc.api-docs.enabled=false
113113
```
114-
114+
115115
## Error Handling for REST using @ControllerAdvice
116116
To generate documentation automatically, make sure all the methods declare the HTTP Code responses using the annotation: @ResponseStatus.
117117

118118
## Adding API Information and Security documentation
119-
The library uses spring-boot application auto-configured packages to scan for the following annotations in spring beans: OpenAPIDefinition and Info.
120-
These annotations declare, API Information: Title, version, licence, security, servers, tags, security and externalDocs.
121-
For better performance of documentation generation, declare `@OpenAPIDefinition` and `@SecurityScheme` annotations within a Spring managed bean.
122-
119+
The library uses spring-boot application auto-configured packages to scan for the following annotations in spring beans: OpenAPIDefinition and Info.
120+
These annotations declare, API Information: Title, version, licence, security, servers, tags, security and externalDocs.
121+
For better performance of documentation generation, declare `@OpenAPIDefinition` and `@SecurityScheme` annotations within a Spring managed bean.
122+
123123
## spring-webflux support with Annotated Controllers
124124
* Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml
125125
* Add the library to the list of your project dependencies ( No additional configuration is needed)
126126

127127
```xml
128128
<dependency>
129-
<groupId>org.springdoc</groupId>
130-
<artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
131-
<version>last-release-version</version>
132-
</dependency>
129+
<groupId>org.springdoc</groupId>
130+
<artifactId>springdoc-openapi-webflux-ui</artifactId>
131+
<version>last-release-version</version>
132+
</dependency>
133133
```
134134
* 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:
135135

@@ -138,7 +138,7 @@ To generate documentation automatically, make sure all the methods declare the H
138138
springdoc.swagger-ui.path=/swagger-ui.html
139139
```
140140

141-
The `springdoc-openapi` libraries are hosted on maven central repository.
141+
The `springdoc-openapi` libraries are hosted on maven central repository.
142142
The artifacts can be viewed accessed at the following locations:
143143

144144
Releases:

0 commit comments

Comments
 (0)