https://github.com/robothy/vertx-openapi-ui
https://github.com/robothy/vertx-openapi-ui
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/robothy/vertx-openapi-ui
- Owner: Robothy
- Created: 2022-11-24T10:17:04.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-11-24T11:41:44.000Z (over 3 years ago)
- Last Synced: 2025-07-15T22:08:34.999Z (12 months ago)
- Language: Java
- Size: 2.21 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vertx-openapi-ui
vertx-openapi-ui is a Java component for Vert.X openapi projects. It exposes an HTTP endpoint `/swagger` that renders the
openapi documents with Swagger-UI.
## Usage
vertx-openapi-ui is a pluggable Java component. Just adding the below dependency to your Vert.X web project could
activate the functionality. You don't need to add any Java code to your sources; unless you want to do some customization.
+ **Step 1** Add the dependency to your `pom.xml` or `build.gradle`.
```xml
io.github.robothy
vertx-openapi-ui
```
+ **Step 2** Restart your Vert.X web app and visit endpoint `http://{host}/swagger`.
You can also customize the endpoint via `VertxSwaggerUI.install("/customized_endpoint")` before deploying the server.