documentation-configuration-metadata-processor

This java annotation processor generates additional spring configuration metadata for the configuration documentation generation plugin.

It's main usage is to generate configuration metadata for classes used in collections in @ConfigurationProperties classes, which are ignored by the spring-boot-configuration-processor.

Usage

Add a dependency to the processor to your POM:

<dependency>
    <groupId>de.eitco.cicd</groupId>
    <artifactId>documentation-configuration-metadata-processor</artifactId>
    <optional>true</optional>
    <version>processor-version</version>
</dependency>

Annotate classes to generate metadata for with:

@AdditionalConfigurationMetadata(groups = {"TestGroup1","TestGroup2"})

The annotation requires one or more group names. The names are used to merge the generated configuration metadata with metadata generated by the spring-boot-configuration-processor. By setting more than ony group it is possible to reuse metadata at several places in the generated documentation.

The processor supports the @NestedConfigurationProperty annotation from Spring Boot in classes annotated with @AdditionalConfigurationMetadata.