io.quarkus.swaggerui.deployment

Class SwaggerUiProcessor.SwaggerUiConfig

java.lang.Object

io.quarkus.swaggerui.deployment.SwaggerUiProcessor.SwaggerUiConfig

Enclosing class:

SwaggerUiProcessor

@ConfigRoot
static final class SwaggerUiProcessor.SwaggerUiConfig
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	alwaysInclude If this should be included every time.
(package private) boolean	enable If Swagger UI should be enabled.
(package private) String	path The path where Swagger UI is available.

Constructor Summary

Constructors

Constructor and Description
SwaggerUiConfig()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

path

@ConfigItem(defaultValue="/swagger-ui")
String path

The path where Swagger UI is available.

The value `/` is not allowed as it blocks the application from serving anything else.

alwaysInclude

@ConfigItem
boolean alwaysInclude

If this should be included every time. By default this is only included when the application is running in dev mode.

enable

@ConfigItem(defaultValue="true")
boolean enable

If Swagger UI should be enabled. By default, Swagger UI is enabled.

Constructor Detail

SwaggerUiConfig

SwaggerUiConfig()