Swagger theme at runtime

[fjoubaud]

In our Swagger interface, we must have a way to distinguish our environments : preprod, test and even prod.
So far we did use quarkus.swagger-ui.theme and quarkus.swagger-ui.title.
Those properties are build time ones.

Considering we build now a generic Docker image, is there anyway to achieve the above at runtime ?
Some control over the Swagger API content ?

[quarkus-bot[bot]]

/cc @MikeEdgar (swagger-ui), @phillip-kruger (swagger-ui)

[phillip-kruger]

Can you not use config profiles ?

[fjoubaud]

We do use config profiles where these 2 properties are customized in each.

The quarkus.io/guides/openapi-swaggerui documentation confirms that those are build time properties (like all other Swagger related properties).

As said, we generate an environment agnostic Docker image (with a uber jar).
When the image is instantiated in prod/preprod/dev - so at runtime - we use the dedicated config profile.
Our problem is that our Swagger interface is then the one specified at build time (which is by default the prod one).

Would you foresee a way to change the Swagger page look and feel at runtime ?
We would like people to be more careful when accessing it in a preprod (or even prod) environment for example.
May be a custom banner accessed outside of the Docker container ?

[phillip-kruger]

Yeah, for this scenario I would recommend looking at Runtime Filters (https://quarkus.io/guides/openapi-swaggerui#runtime-filters) and changing the OpenAPI Schema title to reflect the current runtime.