Home » Java » Enterprise Java » Stylish API

About Phillip Kruger

Phillip Kruger
Phillip is a software developer and a systems architect who knacks for solving problems. He has a passion for clean code and evolutionary architecture. He blogs about all technical things.

Stylish API

In this blog post we are going to look at the new styling and other new options available in OpenAPI and SwaggerUI Quarkus (v1.10.0 +).

Styling

Default style

The default style for Swagger UI has changed from the vanilla Swagger UI to a Quarkus branded page:

In this post we mostly focus on Swagger UI, but the styling options also apply to the GraphQL UI and the Health UI.

Theme

Swagger UI Themes are now available in configuration, with the default theme being ‘feeling blue’.

You can change the theme by setting the quarkus.swagger-ui.theme property, for example:

1
quarkus.swagger-ui.theme=monokai

You can also go back to the original (vanilla) Swagger UI theme:

1
quarkus.swagger-ui.theme=original

Theme options available:

  • feeling-blue (default)
  • original
  • flattop
  • material
  • monokai
  • muted
  • newspaper
  • outline

Logo

As part of the custom branding, you can supply your own logo to replace the Quarkus logo. We are going to use Standard Bank as an example on how you can brand the page:

NOTE: Hot reload is not working for logo changes, and remember browser cache, you might need to force refresh your browser.

To supply your own logo, you need to place a file called logo.png in src/main/resources/META-INF/branding.

Style

You can go further, and supply your own style.css, to fine-tune the branding. In example, to change the topbar of the Swagger-UI screen to the corporate colors of Standard Bank:

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
html{
    box-sizing: border-box;
    overflow: -moz-scrollbars-vertical;
    overflow-y: scroll;
}
 
*,
*:before,
*:after
{
    box-sizing: inherit;
}
 
body{
    margin:0;
    background: whitesmoke;
}
 
.swagger-ui .topbar { <1>
    background-color: #0033a1;
}
 
#footer {
    background-color: #0033a1;
    font-family:sans-serif;
    color:white;
    font-size:70%;
    text-align: center;
}

<1> here set the topbar background color.

You can change any styling element in this css file, you need to place this file called style.css in src/main/resources/META-INF/branding.

Other styling options

You can also set the HTML title, and add a footer:

1
2
quarkus.swagger-ui.title=OpenAPI for Everyone
quarkus.swagger-ui.footer=© 2020 . Standard Bank

Along with other OpenAPI Header fields that can be set via config (as discussed in this post):

1
2
3
4
5
6
7
8
mp.openapi.extensions.smallrye.info.title=Standard Bank API
mp.openapi.extensions.smallrye.info.version=1.0.0
mp.openapi.extensions.smallrye.info.description=The banking API
mp.openapi.extensions.smallrye.info.contact.email=it@standardbank.co.za
mp.openapi.extensions.smallrye.info.contact.name=Standard Bank IT
mp.openapi.extensions.smallrye.info.contact.url=https://www.standardbank.com
mp.openapi.extensions.smallrye.info.license.name=Apache 2.0
mp.openapi.extensions.smallrye.info.license.url=http://www.apache.org/licenses/LICENSE-2.0.html

The UI is now fully branded:

Other Swagger UI Options

Another new feature available in Quarkus (v1.10.0 +) is the ability to set any of the configuration options available in Swagger UI. As an example, we can set the urls and add the petstore (as the default selected option) to Swagger UI:

1
2
3
quarkus.swagger-ui.urls.default=/openapi
quarkus.swagger-ui.urls.petstore=https://petstore.swagger.io/v2/swagger.json
quarkus.swagger-ui.urls-primary-name=petstore

This will change the topbar to have a dropdown box with the urls provided:

Another example, supportedSubmitMethods can hide the Try it out button for certain HTTP Method Types:

1
quarkus.swagger-ui.supported-submit-methods=get

Note below the missing Try it out button on the POST

All other Swagger UI options are now available to configure the UI.

Other Small new features

Two small new features in OpenAPI and Swagger UI, the ability to add the Health Endpoints and the ability to disable the UI and/or Schema in Runtime.

Add Health API to Open API

If you are using the smallrye-health extension, you can add the Health Endpoints to OpenAPI:

1
quarkus.health.openapi.included=true

Disable in Runtime

If you included the UI in your app (quarkus.swagger-ui.always-include=true), you can now disable it when starting the application.

1
java -jar -Dquarkus.swagger-ui.enable=false target/yourapp-1.0.0-runner.jar

This will return a HTTP 404 (Not Found) on the Swagger UI page.

Similarly you can disable the schema (usually under /openai) by doing:

1
java -jar -Dquarkus.smallrye-openapi.enable=false target/yourapp-1.0.0-runner.jar

Published on Java Code Geeks with permission by Phillip Krüger, partner at our JCG program. See the original article here: Stylish API

Opinions expressed by Java Code Geeks contributors are their own.

(0 rating, 0 votes)
You need to be a registered member to rate this.
Start the discussion Views Tweet it!
Do you want to know how to develop your skillset to become a Java Rockstar?
Subscribe to our newsletter to start Rocking right now!
To get you started we give you our best selling eBooks for FREE!
1. JPA Mini Book
2. JVM Troubleshooting Guide
3. JUnit Tutorial for Unit Testing
4. Java Annotations Tutorial
5. Java Interview Questions
6. Spring Interview Questions
7. Android UI Design
and many more ....
I agree to the Terms and Privacy Policy
Subscribe
Notify of
guest

This site uses Akismet to reduce spam. Learn how your comment data is processed.

0 Comments
Inline Feedbacks
View all comments