micronaut.openapi.enabled | System property that enables or disables open api annotation processing. | Default: true |
micronaut.openapi.openapi31.enabled | System property that enables or disables OpenAPI 3.1.0 format. | Default: false |
micronaut.openapi.openapi31.json-schema-dialect | System property that set JSON Schema Dialect for OpenAPI 3.1.0 format. | Default: `` |
micronaut.openapi.swagger.file.generation.enabled | System property that enables or disables generation of a swagger (OpenAPI) specification file. This can be used whenever you already have a specification file and that you only need the Swagger UI. | Default: true |
micronaut.openapi.config.file | | System property that enables setting the open api config file. |
micronaut.openapi.server.context.path | | System property for server context path. |
micronaut.openapi.exclude.classes | | System property to specify list of classes which must be excluded from the final OpenAPI specification. |
micronaut.openapi.exclude.packages | | System property to specify list of packages, containing controllers / endpoints, which must be excluded from the final OpenAPI specification. |
micronaut.openapi.property.naming.strategy | System property for naming strategy. One jackson PropertyNamingStrategy. | Default: LOWER_CAMEL_CASE |
micronaut.openapi.property.property.include | System property for default property inclusion - default Jackson include mode. Available values: "USE_DEFAULTS" and "ALWAYS". | Default: USE_DEFAULTS |
micronaut.openapi.response.read-successful-from-code | If this property true, then successful response will be created from code, if successful code didn’t set in swagger annotations. Otherwise, if swagger annotations are specified, the code will be ignored and responses will be read only from swagger annotations. | Default: true |
micronaut.openapi.views.spec | | System property for views specification. |
micronaut.openapi.target.file | System property that enables setting the target file to write to. | Default: META-INF/swagger/${applicationName}-$7.1.3.yml |
micronaut.openapi.views.dest.dir | System property that specifies the path where the generated UI elements will be located. | Default: META-INF/swagger/views/ |
micronaut.openapi.additional.files | | System property that specifies the location of additional swagger YAML and JSON files to read from.   You can set comma separated list of paths to directories or to OpenAPI filesYou can set your custom paths separated by , . These paths can be paths to directories or to OpenAPI files. To set absolute paths use prefix file: (or without prefix), classpath paths use prefix classpath: or use prefix project: to set paths from project directory.   Example:   micronaut.openapi.additional.files = project:src/test/resources/swagger/openapi.yml,classpath:/swagger/petstore.yml |
micronaut.openapi.additional.files-merge-mode | System property that specifies the mode of merge additional OpenAPI files. Available values: "append" and "replace" .   With append mode: If there are duplicate elements in the generated specification and additional specification files, the element from the generated specification will always be taken.   With replace mode: If there are duplicate elements in the generated specification and additional specification files, the element from the generated specification will always be replaced by the element from the additional files. | Default: replace |
micronaut.openapi.additional.include-patterns | | System property that specifies the list of patterns for included files (separated by , ) |
micronaut.openapi.additional.include-pattern-style | System property that specifies the pattern style for included files. Available values: "ant" and "regex" . | Default: ant |
micronaut.openapi.additional.exclude-patterns | | System property that specifies the list of patterns for excluded files (separated by , ) |
micronaut.openapi.additional.exclude-pattern-style | System property that specifies the pattern style for excluded files. Available values: "ant" and "regex" . | Default: ant |
micronaut.openapi.project.dir | System property that specifies the location of current project. Need to set this property manually if you use kotlin (to save incremental annotation processing) or have some troubles with auto calculation project path. | Default: calculated automatically |
micronaut.openapi.security.default-schema-name | | System property that specifies the default security schema name, if it’s not specified by annotation SecurityScheme. |
micronaut.openapi.security.enabled | If this property true, micronaut-openapi will process micronaut-security properties and annotations to construct openapi security schema. | Default: true |
micronaut.openapi.field.visibility.level | System property that specifies the schema classes fields visibility level. By default, only public fields visible.   Available values: PRIVATE PACKAGE PROTECTED PUBLIC | Default: PUBLIC |
micronaut.openapi.json.format | Is this property true, output file format will be JSON, otherwise YAML. | Default: false |
micronaut.openapi.constructor-arguments-as-required | System property that enables interpret primary constructor arguments as required properties. | Default: true |
micronaut.openapi.generator.extensions.enabled | If this property is 'true', then the generated OpenAPI specification will include extensions for OpenAPI Generator and the generated client according to this specification will be much more accurate than without it. For example, enumerations will be described with extensions x-enum-varnames , x-enum-descriptions and x-deprecated | Default: false |
micronaut.openapi.filename | The name of the result swagger file. | Default: ${info.title}-${info.version}.yml , if info block not set, filename will be swagger.yml . |
micronaut.openapi.environments | | Active micronaut environments which will be used for @Requires annotations. |
micronaut.openapi.environments.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: true |
micronaut.openapi.versioning.enabled | Is this property true, micronaut-openapi will process micronaut-router versioning properties and annotations. | Default: true |
micronaut.server.context-path | | micronaut-http server context path property. |
jackson.json-view.enabled | micronaut-http property ( json-view.enabled ). | Default: false |
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: true |
micronaut.openapi.expand.* | | Prefix for expandable properties. These properties can be used only for placeholders. |
micronaut.openapi.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. |
micronaut.openapi.docs.format | System property to set Javadoc / KDoc conversion mode. Available values: PLAIN , HTML_TO_MD , MD_TO_HTML . | Default: HTML_TO_MD |
micronaut.openapi.operation.duplicate-resolution | System property to set operation ID duplicate resolution. Available values: auto - micronaut-openapi automatically add index suffix to duplicate operation ID. error - micronaut-openapi throws an exception when found duplicate operation IDs. | Default: auto |
micronaut.openapi.schema.extra.enable | If this property true, you can add some extra schemas to final OpenAPI spec file. | Default: false |
micronaut.openapi.schema.duplicate-resolution | System property to set schema duplicate resolution. Available values: auto - micronaut-openapi automatically add index suffix to duplicate schema. error - micronaut-openapi throws an exception when found duplicate schema. | Default: auto |
micronaut.openapi.schema.dynamic-refs.enabled | If this property true and OpenAPI 3.1 generation is enabled, recursive schemas emit JSON Schema 2020-12 $dynamicAnchor / $dynamicRef keywords instead of static self- $ref references, and single-variable generic wrappers ( Foo<T> ) collapse into one reusable template plus inline $defs bindings instead of duplicated concrete schemas. | Default: false |
micronaut.openapi.schema.name.separator.empty | If this property true, generic separators and inner class separators in schema name will be empty string. | Default: false |
micronaut.openapi.schema.name.separator.generic | System property that set generic class separator for schema name generation. | Default: _ |
micronaut.openapi.schema.name.separator.inner-class | System property that set inner class separator for schema name generation. | Default: . |
micronaut.openapi.schema.mapping.* | | Properties prefix to set custom schema implementations for selected classes. 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:       mapping:         org.somepackage.MyComplexType: java.lang.String         org.somepackage.MyComplexType2: java.lang.Integer |
micronaut.openapi.tag.generation.by.class.enabled | System property that enables tag generation by controller class name. | Default: false |
micronaut.openapi.tag.generation.by.package.enabled | System property that enables tag generation by package name. | Default: false |
micronaut.openapi.tag.generation.description.max.length | | Maximal generated tag description length. Description generated by java-doc on controller class level. For tag description, Micronaut OpenAPI get controller class javadoc with summary tag. If javadoc without summary, get first sentence of class javadoc |
micronaut.openapi.tag.generation.naming.strategy | | Naming strategy for generated tags. One jackson PropertyNamingStrategy. |
micronaut.openapi.tag.generation.remove.prefixes | | List of prefixes which need to remove for generated tags. For example, if you generate tags by package, you need to remove package prefix like this com.mycompany.myservice.controller . |
micronaut.openapi.tag.generation.remove.postfixes | List of postfixes which need to remove for generated tags. For example, if you generate tags by class, you need to remove postfixes like Controller or Api . | Default: controller, api, endpoints, endpoint |
micronaut.openapi.groups.* | | Properties prefix to set custom schema implementations for selected classes. 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}-$7.1.3.yml       my-group2:         title: Title 2 |
endpoints.enabled | Process or not endpoints (micronaut-management / spring-boot-actuator / custom endpoints) | Default: false |
endpoints.tags | | Specific tags for all endpoints |
endpoints.path | | Specific path for all endpoints |
endpoints.servers | | Specific servers for all endpoints |
endpoints.security-requirements | | Specific security requirements for endpoints servers |
endpoints.extensions | | Specific Open API extensions for all endpoints |
endpoints.groups | | Specific groups for all endpoints |
endpoints.groups-excluded | | Specific excluded groups for all endpoints |
swagger-ui.enabled | | true or false When 'true' the Swagger UI view is generated. |
swagger-ui.js.url | | Override path to use to find the js file. Path must contain a files named swagger-ui.css, swagger-ui-bundle.js, swagger-ui-standalone-present.js. The value can be a URL path like: "https://cdn.jsdelivr.net/npm/swagger-ui/dist/". Must contain trailing slash., |
swagger-ui.spec.url | | Override path in swagger file path line. If you don’t set, then value will be <context-path>/swagger/<spec_filename> . You can use the placeholder ${filename} it will be replaced with the final name of the generated swagger file. |
swagger-ui.copy-resources | | Copy or not local JS and CSS resources. Set to false if you are using external resources (e.g. https://cdn.jsdelivr.net/npm/swagger-ui/dist/ ). Default true |
swagger-ui.theme | | DEFAULT or MATERIAL or FEELING_BLUE FLATTOP MONOKAI MUTED NEWSPAPER OUTLINE DARK DARK2 . The theme of swagger-ui to use. These are case-insensitive. Default is DEFAULT . See Swagger UI Themes . |
swagger-ui.theme.url | | Override path to use to find the theme CSS file., |
swagger-ui.copy-theme | | Copy or not local theme CSS resources. Set to false if you are using external resources (e.g. https://swagger-theme.com/flattop.css ). Default true |
swagger-ui.layout | | |
swagger-ui.filter | | |
redoc.enabled | | true or false When 'true' the ReDoc view is generated. |
redoc.js.url | | Override path to use to find the js file. Path must contain a file named redoc.standalone.js. The value can be a URL path like: "https://cdn.jsdelivr.net/npm/redoc/bundles/". Must contain trailing slash. |
redoc.spec.url | | Override path in swagger file path line. If you don’t set, then value will be <context-path>/swagger/<spec_filename> . You can use the placeholder ${filename} it will be replaced with the final name of the generated swagger file. |
redoc.copy-resources | | Copy or not local JS and CSS resources. Set to false if you are using external resources (e.g. https://cdn.jsdelivr.net/npm/redoc/bundles/ ). Default true |
redoc.expand-single-schema-field | | |
redoc.expand-default-server-variables | | |
redoc.menu-toggle | | |
redoc.only-required-in-samples | | |
redoc.payload-sample-idx | | |
redoc.sort-props-alphabetically | | |
redoc.untrusted-spec | | |
redoc.expand-responses | | |
redoc.show-extensions | | |
redoc.native-scrollbars | | |
redoc.path-in-middle-panel | | |
redoc.suppress-warnings | | |
redoc.hide-hostname | | |
redoc.disable-search | | |
redoc.json-sample-expand-level | | |
redoc.scroll-y-offset | | |
redoc.hide-download-button | | |
redoc.no-auto-auth | | |
redoc.theme | | |
redoc.hide-single-request-sample-tab | | |
redoc.required-props-first | | |
redoc.hide-loading | | |
openapi-explorer.enabled | | true or false When 'true' the OpenAPI Explorer view is generated. |
openapi-explorer.js.url | | Override path to use to find the js and other resource files. Path must contain a file named openapi-explorer.min.js. The value can be a URL path like: "https://cdn.jsdelivr.net/npm/openapi-explorer/dist/". Must contain trailing slash. |
openapi-explorer.spec.url | | Override path in swagger file path line. If you don’t set, then value will be <context-path>/swagger/<spec_filename> . You can use the placeholder ${filename} it will be replaced with the final name of the generated swagger file. |
openapi-explorer.copy-resources | | Copy or not local JS and CSS resources. Set to false if you are using external resources (e.g. https://cdn.jsdelivr.net/npm/openapi-explorer/dist/browser/openapi-explorer.min.js ). Default true |
openapi-explorer.expand-single-schema-field | | |
openapi-explorer.expand-default-server-variables | | |
openapi-explorer.menu-toggle | | |
openapi-explorer.only-required-in-samples | | |
openapi-explorer.payload-sample-idx | | |
openapi-explorer.sort-props-alphabetically | | |
openapi-explorer.untrusted-spec | | |
openapi-explorer.expand-responses | | |
openapi-explorer.show-extensions | | |
openapi-explorer.native-scrollbars | | |
openapi-explorer.path-in-middle-panel | | |
openapi-explorer.suppress-warnings | | |
openapi-explorer.hide-hostname | | |
openapi-explorer.disable-search | | |
openapi-explorer.json-sample-expand-level | | |
openapi-explorer.scroll-y-offset | | |
openapi-explorer.hide-download-button | | |
openapi-explorer.no-auto-auth | | |
openapi-explorer.theme | | |
openapi-explorer.hide-single-request-sample-tab | | |
openapi-explorer.required-props-first | | |
openapi-explorer.hide-loading | | |
scalar.enabled | | true or false When 'true' the scalar view is generated. |
scalar.js.url | | Override path to use to find the js file. Path must contain a file named scalar.standalone.js. The value can be a URL path like: "https://cdn.jsdelivr.net/npm/scalar/bundles/". Must contain trailing slash. |
scalar.spec.url | | Override path in swagger file path line. If you don’t set, then value will be <context-path>/swagger/<spec_filename> . You can use the placeholder ${filename} it will be replaced with the final name of the generated swagger file. |
scalar.copy-resources | | Copy or not local JS and CSS resources. Set to false if you are using external resources (e.g. https://cdn.jsdelivr.net/npm/scalar/bundles/ ). Default true |
scalar.style | | Custom CSS style description for scalar. Inserted into the block: <style>${scalar.style}</style> |
scalar.theme | | |
scalar.spec | | |
scalar.servers | | |
scalar.metadata | | |
scalar.favicon | | |
scalar.authentication | | |
rapidoc.enabled | | true or false When 'true' the RapiDoc view is generated. |
rapidoc.js.url | | Override path to use to find the js file. Path must contain a file named rapidoc-min.js. The value can be a URL path like: "https://cdn.jsdelivr.net/npm/rapidoc/dist/". Must contain trailing slash. |
rapidoc.spec.url | | Override path in swagger file path line. If you don’t set, then value will be <context-path>/swagger/<spec_filename> . You can use the placeholder ${filename} it will be replaced with the final name of the generated swagger file. |
rapidoc.copy-resources | | Copy or not local JS and CSS resources. Set to false if you are using external resources (e.g. https://cdn.jsdelivr.net/npm/rapidoc/dist/ ). Default true |
rapidoc.style | | |
rapidoc.sort-tags | | |
rapidoc.sort-endpoints-by | | |
rapidoc.heading-text | | |
rapidoc.goto-path | | |
rapidoc.theme | | |
rapidoc.bg-color | | |
rapidoc.text-color | | |
rapidoc.header-color | | |
rapidoc.regular-font | | |
rapidoc.mono-font | | |
rapidoc.font-size | | |
rapidoc.nav-bg-color | | |
rapidoc.nav-text-color | | |
rapidoc.nav-hover-bg-color | | |
rapidoc.nav-hover-text-color | | |
rapidoc.nav-accent-color | | |
rapidoc.nav-item-spacing | | |
rapidoc.layout | | |
rapidoc.render-style | | |
rapidoc.schema-style | | |
rapidoc.schema-expand-level | | |
rapidoc.schema-description-expanded | | |
rapidoc.default-schema-tab | | |
rapidoc.response-area-height | | |
rapidoc.show-info | | |
rapidoc.info-description-headings-in-navbar | | |
rapidoc.show-components | | |
rapidoc.show-header | | |
rapidoc.allow-authentication | | |
rapidoc.allow-spec-url-load | | |
rapidoc.allow-spec-file-load | | |
rapidoc.allow-search | | |
rapidoc.allow-try | | |
rapidoc.allow-server-selection | | |
rapidoc.api-key-name | | |
rapidoc.api-key-value | | |
rapidoc.api-key-location | | |
rapidoc.server-url | | |
rapidoc.default-api-server | | |
rapipdf.enabled | | true or false , |
rapipdf.js.url | | Override path to use to find the js file. Path must contain a file named rapdipdf-min.js. The value can be a URL path like: "https://cdn.jsdelivr.net/npm/rapipd/dist/". Must contain trailing slash., |
rapipdf.spec.url | | Override path in swagger file path line. If you don’t set, then value will be <context-path>/swagger/<spec_filename> . You can use the placeholder ${filename} it will be replaced with the final name of the generated swagger file. |
rapipdf.copy-resources | | Copy or not local JS and CSS resources. Set to false if you are using external resources (e.g. https://cdn.jsdelivr.net/npm/rapipdf/dist/ ). Default true |
rapipdf.include-api-details | | rapipdf.pdf-title |
rapipdf.include-api-list | | rapipdf.include-security |
rapipdf.input-bg | | rapipdf.hide-input |
rapipdf.pdf-footer-text | | rapipdf.pdf-primary-color |
rapipdf.pdf-schema-style | | rapipdf.button-label |
rapipdf.pdf-alternate-color | | rapipdf.include-info |
rapipdf.include-toc | | rapipdf.button-color |
rapipdf.style | | rapipdf.input-color |
micronaut.openapi.adoc.enabled | System property that enables or disables open api asciidoc conversion. | Default: true |
micronaut.openapi.adoc.template.dir | Template directory path. | Default: classpath:/template |
micronaut.openapi.adoc.template.filename | Main template filename. | Default: openApiDoc.ftl (in classpath) |
micronaut.openapi.adoc.output.dir | Output directory path. | Default: standard micronaut openapi output directory path |
micronaut.openapi.adoc.output.filename | Final adoc file name. | Default: the same as OpenAPI spec. filename |
micronaut.openapi.adoc.templates.* | | Prefix for custom template names. You can override any of the templates that are used in the default implementation to change only part of the resulting document. |
