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.
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
Add Swagger UI Options via config #12782
Conversation
.../swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is VERY nice. I wanted that for so long.
I added several totally uninteresting comments related to doc (sorry!) :).
.../swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java
Outdated
Show resolved
Hide resolved
.../swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java
Outdated
Show resolved
Hide resolved
.../swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java
Outdated
Show resolved
Hide resolved
.../swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java
Show resolved
Hide resolved
.../swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java
Show resolved
Hide resolved
.../swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java
Show resolved
Hide resolved
.../swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java
Show resolved
Hide resolved
.../swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java
Show resolved
Hide resolved
.../swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java
Outdated
Show resolved
Hide resolved
.../swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java
Outdated
Show resolved
Hide resolved
.../swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java
Outdated
Show resolved
Hide resolved
Signed-off-by: Phillip Kruger <phillip.kruger@gmail.com>
Outstanding job @phillip-kruger ! Nice! |
Glad we finally have this one in! Thanks! |
hi any chance this will make it into 1.9.x? Or do we need to wait for 1.10? Thanks |
This is planned for 1.10. According to https://github.com/quarkusio/quarkus/wiki/Release-Planning, the first CR should be available on Nov 10th. |
Great feature really like it! One question though, is it possible to change the logo at the top of Swagger UI? Currently it is the 'Quarkus' logo displayed but I can't find a way to have a custom one. Thanks, |
@phillip-kruger awesome big thx! :) |
@phillip-kruger I got the logo customization working after a while (worked when Quarkus was running in dev-mode but not using an executable jar or native). I noticed that I needed to specify the prepare-goal in the execution-section of the quarkus-maven-plugin (I only had the build-goal earlier). Might be good to add this info an upcoming guide since a bit tricky to figure out :) Otherwise it works like a charm now, great job! |
This PR adds all the options from Swagger UI as config options. (see https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/)
It supersede #6314.
Close #6314
Fix #5639
Fix #4766
from #5639
(f.y.i - @misaunde and @valones)
from #6314
(f.y.i - @yntelectual @Postremus @aoudiamoncef)
You can add multiple urls now:
This will create the dropdown in the header:
from #4766
(f.y.i - @btsibr @Agh42)
Other
Theme
You can now select any theme from https://github.com/ostranme/swagger-ui-themes, example:
Footer
You can add a footer:
Title
You can set the HTML title
Default title will be: OpenAPI UI (Powered by Quarkus version-number-here)
All other options from swagger ui available via config.
In dev mode, the options will take effect immediately.
Signed-off-by:Phillip Kruger phillip.kruger@gmail.com