Package 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 Details

    • 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.

    • alwaysRunFilter

      @ConfigItem(defaultValue="false") public boolean alwaysRunFilter
      Do not run the filter only at startup, but every time the document is requested (dynamic).

    • ignoreStaticDocument

      @ConfigItem(defaultValue="false") public boolean ignoreStaticDocument
      Do not include the provided static openapi document (eg. META-INF/openapi.yaml)

    • managementEnabled

      @ConfigItem(name="management.enabled", defaultValue="true") public boolean managementEnabled
      If management interface is turned on the openapi schema document will be published under the management interface. This allows you to exclude OpenAPI from management by setting the value to false

    • additionalDocsDirectory

      @ConfigItem public Optional<List<Path>> additionalDocsDirectory
      A list of local directories that should be scanned for yaml and/or json files to be included in the static model. Example: `META-INF/openapi/`

    • securityScheme

      @ConfigItem public Optional<SmallRyeOpenApiConfig.SecurityScheme> securityScheme
      Add a certain SecurityScheme with config

    • securitySchemeName

      @ConfigItem(defaultValue="SecurityScheme") public String securitySchemeName
      Add a Security Scheme name to the generated OpenAPI document

    • securitySchemeDescription

      @ConfigItem(defaultValue="Authentication") public String securitySchemeDescription
      Add a description to the Security Scheme

    • securitySchemeExtensions

      @ConfigItem public Map<String,String> securitySchemeExtensions
      Add one or more extensions to the security scheme

    • autoAddSecurityRequirement

      @ConfigItem(defaultValue="true") public boolean autoAddSecurityRequirement
      This will automatically add the security requirement to all methods/classes that has a `RolesAllowed` annotation.

    • autoAddTags

      @ConfigItem(defaultValue="true") public boolean autoAddTags
      This will automatically add tags to operations based on the Java class name.

    • autoAddServer

      @ConfigItem public Optional<Boolean> autoAddServer
      Setting it to `true` will automatically add a default server to the schema if none is provided, using the current running server host and port.

    • autoAddSecurity

      @ConfigItem(defaultValue="true") public boolean autoAddSecurity
      This will automatically add security based on the security extension included (if any).

    • apiKeyParameterIn

      @ConfigItem public Optional<String> apiKeyParameterIn
      Required when using `apiKey` security. The location of the API key. Valid values are "query", "header" or "cookie".

    • apiKeyParameterName

      @ConfigItem public Optional<String> apiKeyParameterName
      Required when using `apiKey` security. The name of the header, query or cookie parameter to be used.

    • basicSecuritySchemeValue

      @ConfigItem(defaultValue="basic") public String basicSecuritySchemeValue
      Add a scheme value to the Basic HTTP Security Scheme

    • jwtSecuritySchemeValue

      @ConfigItem(defaultValue="bearer") public String jwtSecuritySchemeValue
      Add a scheme value to the JWT Security Scheme

    • jwtBearerFormat

      @ConfigItem(defaultValue="JWT") public String jwtBearerFormat
      Add a bearer format the JWT Security Scheme

    • oauth2SecuritySchemeValue

      @ConfigItem(defaultValue="bearer") public String oauth2SecuritySchemeValue
      Add a scheme value to the OAuth2 opaque token Security Scheme

    • oauth2BearerFormat

      @ConfigItem(defaultValue="Opaque") public String oauth2BearerFormat
      Add a scheme value to OAuth2 opaque token Security Scheme

    • oidcOpenIdConnectUrl

      @ConfigItem public Optional<String> oidcOpenIdConnectUrl
      Add a openIdConnectUrl value to the OIDC Security Scheme

    • oauth2ImplicitRefreshUrl

      @ConfigItem public Optional<String> oauth2ImplicitRefreshUrl
      Add a implicit flow refreshUrl value to the OAuth2 Security Scheme

    • oauth2ImplicitAuthorizationUrl

      @ConfigItem public Optional<String> oauth2ImplicitAuthorizationUrl
      Add an implicit flow authorizationUrl value to the OAuth2 Security Scheme

    • oauth2ImplicitTokenUrl

      @ConfigItem public Optional<String> oauth2ImplicitTokenUrl
      Add an implicit flow tokenUrl value to the OAuth2 Security Scheme

    • openApiVersion

      @ConfigItem public Optional<String> openApiVersion
      Override the openapi version in the Schema document

    • infoTitle

      @ConfigItem public Optional<String> infoTitle
      Set the title in Info tag in the Schema document

    • infoVersion

      @ConfigItem public Optional<String> infoVersion
      Set the version in Info tag in the Schema document

    • infoDescription

      @ConfigItem public Optional<String> infoDescription
      Set the description in Info tag in the Schema document

    • infoTermsOfService

      @ConfigItem public Optional<String> infoTermsOfService
      Set the terms of the service in Info tag in the Schema document

    • infoContactEmail

      @ConfigItem public Optional<String> infoContactEmail
      Set the contact email in Info tag in the Schema document

    • infoContactName

      @ConfigItem public Optional<String> infoContactName
      Set the contact name in Info tag in the Schema document

    • infoContactUrl

      @ConfigItem public Optional<String> infoContactUrl
      Set the contact url in Info tag in the Schema document

    • infoLicenseName

      @ConfigItem public Optional<String> infoLicenseName
      Set the license name in Info tag in the Schema document

    • infoLicenseUrl

      @ConfigItem public Optional<String> infoLicenseUrl
      Set the license url in Info tag in the Schema document

    • operationIdStrategy

      @ConfigItem public Optional<SmallRyeOpenApiConfig.OperationIdStrategy> operationIdStrategy
      Set the strategy to automatically create an operation Id

  • Constructor Details

    • SmallRyeOpenApiConfig

      public SmallRyeOpenApiConfig()

  • Method Details

    • getValidSecuritySchemeExtentions

      public Map<String,String> getValidSecuritySchemeExtentions()