Skip to content

Improve README #3217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bwaldvogel wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve README #3217

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8648f87
Fix broken URL in README
bwaldvogel Feb 9, 2026
5ac3a04
Improve casing in README
bwaldvogel Feb 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,10 @@ Pivotal)
* Automatically deploys swagger-ui to a Spring Boot 3.x application
* Documentation will be available in HTML format, using the
official [swagger-ui jars](https://github.com/swagger-api/swagger-ui.git).
* 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
* 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
* `server`: The server name or IP
* `port`: The server port
* `context-path`: The context path of the application
Expand Down Expand Up @@ -155,7 +156,7 @@ springdoc.swagger-ui.path=/swagger-ui.html

## Integration of the library in a Spring Boot 3.x project without the swagger-ui:

* Documentation will be available at the following url for json format: http://server:
* Documentation will be available at the following url for JSON format: http://server:
port/context-path/v3/api-docs
* `server`: The server name or IP
* `port`: The server port
Expand Down