io.quarkus.smallrye.openapi.common.deployment

Class SmallRyeOpenApiConfig

java.lang.Object

io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

@ConfigRoot(name="smallrye-openapi")
public final class SmallRyeOpenApiConfig
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
String	path The path at which to register the OpenAPI Servlet.
Optional<Path>	storeSchemaDirectory If set, the generated OpenAPI schema documents will be stored here on build.

Constructor Summary

Constructors

Constructor and Description
SmallRyeOpenApiConfig()

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="/openapi")
public String path

The path at which to register the OpenAPI Servlet.

storeSchemaDirectory

@ConfigItem
public Optional<Path> storeSchemaDirectory

If set, the generated OpenAPI schema documents will be stored here on build. Both openapi.json and openapi.yaml will be stored here if this is set.

Constructor Detail

SmallRyeOpenApiConfig

public SmallRyeOpenApiConfig()