io.micronaut.openapi.visitor

Interface OpenApiConfigProperty

public interface OpenApiConfigProperty

Supported configuration properties.

Since:

4.10.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set<java.lang.String>	ALL All supported annotation processor properties.
static java.lang.String	MICRONAUT_CONFIG_FILE_LOCATIONS Config file locations.
static java.lang.String	MICRONAUT_ENVIRONMENT_ENABLED Is this property true, properties wll be loaded in the standard way from application.yml.
static java.lang.String	MICRONAUT_JACKSON_JSON_VIEW_ENABLED Loaded micronaut-http-server-netty property (json-view.enabled).
static java.lang.String	MICRONAUT_OPENAPI_ADDITIONAL_FILES System property that specifies the location of additional swagger YAML and JSON files to read from.
static java.lang.String	MICRONAUT_OPENAPI_CONFIG_FILE System property that enables setting the open api config file.
static java.lang.String	MICRONAUT_OPENAPI_CONTEXT_SERVER_PATH System property for server context path.
static java.lang.String	MICRONAUT_OPENAPI_ENABLED System property that enables or disables open api annotation processing.
static java.lang.String	MICRONAUT_OPENAPI_ENVIRONMENTS Active micronaut environments which will be used for @Requires annotations.
static java.lang.String	MICRONAUT_OPENAPI_EXPAND_PREFIX Prefix for expandable properties.
static java.lang.String	MICRONAUT_OPENAPI_FIELD_VISIBILITY_LEVEL System property that specifies the schema classes fields visibility level.
static java.lang.String	MICRONAUT_OPENAPI_FILENAME The name of the result swagger file.
static java.lang.String	MICRONAUT_OPENAPI_GROUPS Properties prefix to set custom schema implementations for selected clases.
static java.lang.String	MICRONAUT_OPENAPI_JSON_FORMAT Is this property true, output file format will be JSON, otherwise YAML.
static java.lang.String	MICRONAUT_OPENAPI_JSON_VIEW_DEFAULT_INCLUSION Property that determines whether properties that have no view annotations are included in JSON serialization views.
static java.lang.String	MICRONAUT_OPENAPI_PROJECT_DIR System property that specifies the location of current project.
static java.lang.String	MICRONAUT_OPENAPI_PROPERTY_NAMING_STRATEGY System property for naming strategy.
static java.lang.String	MICRONAUT_OPENAPI_SCHEMA Properties prefix to set custom schema implementations for selected clases.
static java.lang.String	MICRONAUT_OPENAPI_SCHEMA_POSTFIX
static java.lang.String	MICRONAUT_OPENAPI_SCHEMA_PREFIX Properties prefix to set schema name prefix or postfix by package.
static java.lang.String	MICRONAUT_OPENAPI_SECURITY_DEFAULT_SCHEMA_NAME System property that specifies the default security schema name, if it's not specified by annotation SecurityScheme.
static java.lang.String	MICRONAUT_OPENAPI_SECURITY_ENABLED Is this property true, micronaut-openapi will process micronaut-security properties and annotations to construct openapi security schema.
static java.lang.String	MICRONAUT_OPENAPI_TARGET_FILE System property that enables setting the target file to write to.
static java.lang.String	MICRONAUT_OPENAPI_VERSIONING_ENABLED Is this property true, micronaut-openapi will process micronaut-router versioning prpoerties and annotations.
static java.lang.String	MICRONAUT_OPENAPI_VIEWS_DEST_DIR System property that specifies the path where the generated UI elements will be located.
static java.lang.String	MICRONAUT_OPENAPI_VIEWS_SPEC System property for views specification.
static java.lang.String	MICRONAUT_SERVER_CONTEXT_PATH Loaded micronaut-http server context path property.
static java.lang.String	OPENAPI_CONFIG_FILE Default openapi config file.

Field Detail

MICRONAUT_OPENAPI_ENABLED

static final java.lang.String MICRONAUT_OPENAPI_ENABLED

System property that enables or disables open api annotation processing.
Default: true

See Also:

Constant Field Values

MICRONAUT_OPENAPI_CONFIG_FILE

static final java.lang.String MICRONAUT_OPENAPI_CONFIG_FILE

System property that enables setting the open api config file.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_EXPAND_PREFIX

static final java.lang.String MICRONAUT_OPENAPI_EXPAND_PREFIX

Prefix for expandable properties.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_CONTEXT_SERVER_PATH

static final java.lang.String MICRONAUT_OPENAPI_CONTEXT_SERVER_PATH

System property for server context path.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_PROPERTY_NAMING_STRATEGY

static final java.lang.String MICRONAUT_OPENAPI_PROPERTY_NAMING_STRATEGY

System property for naming strategy. One jackson PropertyNamingStrategy.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_VIEWS_SPEC

static final java.lang.String MICRONAUT_OPENAPI_VIEWS_SPEC

System property for views specification.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_TARGET_FILE

static final java.lang.String MICRONAUT_OPENAPI_TARGET_FILE

System property that enables setting the target file to write to.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_VIEWS_DEST_DIR

static final java.lang.String MICRONAUT_OPENAPI_VIEWS_DEST_DIR

System property that specifies the path where the generated UI elements will be located.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_ADDITIONAL_FILES

static final java.lang.String MICRONAUT_OPENAPI_ADDITIONAL_FILES

System property that specifies the location of additional swagger YAML and JSON files to read from.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_PROJECT_DIR

static final java.lang.String MICRONAUT_OPENAPI_PROJECT_DIR

System property that specifies the location of current project.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_SECURITY_DEFAULT_SCHEMA_NAME

static final java.lang.String MICRONAUT_OPENAPI_SECURITY_DEFAULT_SCHEMA_NAME

System property that specifies the default security schema name, if it's not specified by annotation SecurityScheme.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_FIELD_VISIBILITY_LEVEL

static final java.lang.String MICRONAUT_OPENAPI_FIELD_VISIBILITY_LEVEL

System property that specifies the schema classes fields visibility level. By default, only public fields visibile.

Available values:

PRIVATE PACKAGE PROTECTED PUBLIC

See Also:

Constant Field Values

MICRONAUT_OPENAPI_JSON_FORMAT

static final java.lang.String MICRONAUT_OPENAPI_JSON_FORMAT

Is this property true, output file format will be JSON, otherwise YAML.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_FILENAME

static final java.lang.String MICRONAUT_OPENAPI_FILENAME

The name of the result swagger file.

Default filename is <info.title>-<info.version>.yml. If info annotation not set, filename will be swagger.yml.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_ENVIRONMENTS

static final java.lang.String MICRONAUT_OPENAPI_ENVIRONMENTS

Active micronaut environments which will be used for @Requires annotations.

See Also:

Constant Field Values

MICRONAUT_ENVIRONMENT_ENABLED

static final java.lang.String MICRONAUT_ENVIRONMENT_ENABLED

Is this property true, properties wll be loaded in the standard way from application.yml. Also, environments from "micronaut.openapi.environments" property will set as additional environments, if you want to set specific environment name for openAPI generator.
Default value is "true".

See Also:

Constant Field Values

MICRONAUT_OPENAPI_SECURITY_ENABLED

static final java.lang.String MICRONAUT_OPENAPI_SECURITY_ENABLED

Is this property true, micronaut-openapi will process micronaut-security properties and annotations to construct openapi security schema.
Default value is "true".

See Also:

Constant Field Values

MICRONAUT_OPENAPI_VERSIONING_ENABLED

static final java.lang.String MICRONAUT_OPENAPI_VERSIONING_ENABLED

Is this property true, micronaut-openapi will process micronaut-router versioning prpoerties and annotations.
Default value is "true".

See Also:

Constant Field Values

MICRONAUT_CONFIG_FILE_LOCATIONS

static final java.lang.String MICRONAUT_CONFIG_FILE_LOCATIONS

Config file locations. By default, micronaut-openapi search config in standard path: <project_path>/src/main/resources/

You can set your custom paths separated by ','. To set absolute paths use prefix 'file:', classpath paths use prefix 'classpath:' or use prefix 'project:' to set paths from project directory.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_JSON_VIEW_DEFAULT_INCLUSION

static final java.lang.String MICRONAUT_OPENAPI_JSON_VIEW_DEFAULT_INCLUSION

Property that determines whether properties that have no view annotations are included in JSON serialization views. If enabled, non-annotated properties will be included; when disabled, they will be excluded.
Default value is "true".

See Also:

Constant Field Values

MICRONAUT_SERVER_CONTEXT_PATH

static final java.lang.String MICRONAUT_SERVER_CONTEXT_PATH

Loaded micronaut-http server context path property.

See Also:

Constant Field Values

MICRONAUT_JACKSON_JSON_VIEW_ENABLED

static final java.lang.String MICRONAUT_JACKSON_JSON_VIEW_ENABLED

Loaded micronaut-http-server-netty property (json-view.enabled).

See Also:

Constant Field Values

MICRONAUT_OPENAPI_SCHEMA

static final java.lang.String MICRONAUT_OPENAPI_SCHEMA

Properties prefix to set custom schema implementations for selected clases. For example, if you want to set simple 'java.lang.String' class to some complex 'org.somepackage.MyComplexType' class you need to write:

micronaut.openapi.schema.org.somepackage.MyComplexType=java.lang.String

Also, you can set it in your application.yml file like this:

micronaut: openapi: schema: org.somepackage.MyComplexType: java.lang.String org.somepackage.MyComplexType2: java.lang.Integer ...

See Also:

Constant Field Values

MICRONAUT_OPENAPI_SCHEMA_PREFIX

static final java.lang.String MICRONAUT_OPENAPI_SCHEMA_PREFIX

Properties prefix to set schema name prefix or postfix by package. For example, if you have some classes with same names in different packages you can set postfix like this:

micronaut.openapi.schema-postfix.org.api.v1_0_0=1_0_0 micronaut.openapi.schema-postfix.org.api.v2_0_0=2_0_0

Also, you can set it in your application.yml file like this:

micronaut: openapi: schema-postfix: org.api.v1_0_0: 1_0_0 org.api.v2_0_0: 2_0_0 ...

See Also:

Constant Field Values

MICRONAUT_OPENAPI_SCHEMA_POSTFIX

static final java.lang.String MICRONAUT_OPENAPI_SCHEMA_POSTFIX

See Also:

Constant Field Values

MICRONAUT_OPENAPI_GROUPS

static final java.lang.String MICRONAUT_OPENAPI_GROUPS

Properties prefix to set custom schema implementations for selected clases. For example, if you want to set simple 'java.lang.String' class to some complex 'org.somepackage.MyComplexType' class you need to write:

-Dmicronaut.openapi.group.my-group1.title="Title 1"

Also, you can set it in your application.yml file like this:

micronaut: openapi: group: my-group1: title: Title 1 filename: swagger-${group}-${apiVersion}-${version}.yml my-group2: title: Title 2 ...

See Also:

Constant Field Values

OPENAPI_CONFIG_FILE

static final java.lang.String OPENAPI_CONFIG_FILE

Default openapi config file.

See Also:

Constant Field Values

ALL

static final java.util.Set<java.lang.String> ALL

All supported annotation processor properties.