Skip to content

Add Swagger UI for interactive API documentation #4211

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
ajantha-bhat wants to merge 3 commits into
base: main
Choose a base branch
from
+8 −0
Open

Add Swagger UI for interactive API documentation #4211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d2e2c94
feat(server): add Swagger UI for interactive API documentation
ajantha-bhat Apr 15, 2026
10210d9
fix(license): add license entries for smallrye-openapi transitive dep…
ajantha-bhat Apr 15, 2026
d5a22c1
fix: remove always-include to avoid exposing Swagger UI in production
ajantha-bhat Apr 15, 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
1 change: 1 addition & 0 deletions runtime/defaults/src/main/resources/application.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ quarkus.otel.enabled=true
#quarkus.mongodb.metrics.enabled=true
#quarkus.mongodb.connection-string=mongodb://localhost:27017
quarkus.datasource.db-kind=postgresql
quarkus.smallrye-openapi.store-schema-directory=build/openapi

# ---- Runtime Configuration ----
# Below are default values for properties that can be changed in runtime.
Expand Down
6 changes: 6 additions & 0 deletions runtime/server/distribution/LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,8 @@ This product bundles Quarkus.
* Maven group:artifact IDs: io.quarkus:quarkus-smallrye-fault-tolerance
* Maven group:artifact IDs: io.quarkus:quarkus-smallrye-health
* Maven group:artifact IDs: io.quarkus:quarkus-smallrye-jwt-build
* Maven group:artifact IDs: io.quarkus:quarkus-smallrye-openapi
* Maven group:artifact IDs: io.quarkus:quarkus-swagger-ui
* Maven group:artifact IDs: io.quarkus:quarkus-tls-registry
* Maven group:artifact IDs: io.quarkus:quarkus-tls-registry-spi
* Maven group:artifact IDs: io.quarkus:quarkus-transaction-annotations
Expand Down Expand Up @@ -383,6 +385,7 @@ This product bundles several SmallRye project artifacts.
* Maven group:artifact IDs: io.smallrye.reactive:smallrye-reactive-converter-api
* Maven group:artifact IDs: io.smallrye.reactive:smallrye-reactive-converter-mutiny
* Maven group:artifact IDs: io.smallrye.reactive:vertx-mutiny-generator
* Maven group:artifact IDs: io.smallrye:jandex
* Maven group:artifact IDs: io.smallrye:smallrye-context-propagation
* Maven group:artifact IDs: io.smallrye:smallrye-context-propagation-api
* Maven group:artifact IDs: io.smallrye:smallrye-context-propagation-jta
Expand All @@ -399,6 +402,8 @@ This product bundles several SmallRye project artifacts.
* Maven group:artifact IDs: io.smallrye:smallrye-health-api
* Maven group:artifact IDs: io.smallrye:smallrye-health-provided-checks
* Maven group:artifact IDs: io.smallrye:smallrye-jwt
* Maven group:artifact IDs: io.smallrye:smallrye-open-api-core
* Maven group:artifact IDs: io.smallrye:smallrye-open-api-model
* Maven group:artifact IDs: io.smallrye:smallrye-jwt-build
* Maven group:artifact IDs: io.smallrye:smallrye-jwt-common

Expand Down Expand Up @@ -1618,6 +1623,7 @@ This product bundles Microprofile.
* Maven group:artifact IDs: org.eclipse.microprofile.fault-tolerance:microprofile-fault-tolerance-api
* Maven group:artifact IDs: org.eclipse.microprofile.health:microprofile-health-api
* Maven group:artifact IDs: org.eclipse.microprofile.jwt:microprofile-jwt-auth-api
* Maven group:artifact IDs: org.eclipse.microprofile.openapi:microprofile-openapi-api
* Maven group:artifact IDs: org.eclipse.microprofile.reactive-streams-operators:microprofile-reactive-streams-operators-api
* Maven group:artifact IDs: org.eclipse.microprofile.reactive-streams-operators:microprofile-reactive-streams-operators-core

Expand Down
1 change: 1 addition & 0 deletions runtime/service/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ dependencies {
implementation("io.quarkus:quarkus-reactive-routes")
implementation("io.quarkus:quarkus-hibernate-validator")
implementation("io.quarkus:quarkus-smallrye-health")
implementation("io.quarkus:quarkus-smallrye-openapi")
implementation("io.quarkus:quarkus-micrometer")
implementation("io.quarkus:quarkus-micrometer-registry-prometheus")
implementation("io.quarkus:quarkus-oidc")
Expand Down
Loading