asyncapi:generate

Full name:

de.dentrassi.maven:asyncapi:0.0.4:generate

Description:

Generate sources from AsyncAPI definition

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: generate-sources.

Required Parameters

Name Type Since Description
characterSet String - The character set to use for generated resources
Default value is: ${project.build.sourceEncoding}.
User property is: asyncapi.generator.charset.
definitionFile File - (no description)
Default value is: ${project.basedir}/src/main/asyncapi.yaml.
User property is: asyncapi.definition.
targetPath File - The path to generate the sources to
Default value is: ${project.build.directory}/generated-sources/asyncapi.

Optional Parameters

Name Type Since Description
extensions Set - (no description)
ignoreMissingDefinition boolean - (no description)
Default value is: true.
User property is: asyncapi.ignoreMissingDefinition.
packageBase String - The Java base package for generated

Will use the baseTopic prefix from the API model is unspecified


User property is: asyncapi.generator.packageBase.
skip boolean - Allows to skip the whole generation step
Default value is: false.
User property is: asyncapi.skip.

Parameter Details

characterSet:

The character set to use for generated resources
  • Type: java.lang.String
  • Required: Yes
  • User Property: asyncapi.generator.charset
  • Default: ${project.build.sourceEncoding}

definitionFile:

(no description)
  • Type: java.io.File
  • Required: Yes
  • User Property: asyncapi.definition
  • Default: ${project.basedir}/src/main/asyncapi.yaml

extensions:

(no description)
  • Type: java.util.Set
  • Required: No

ignoreMissingDefinition:

(no description)
  • Type: boolean
  • Required: No
  • User Property: asyncapi.ignoreMissingDefinition
  • Default: true

packageBase:

The Java base package for generated

Will use the baseTopic prefix from the API model is unspecified

  • Type: java.lang.String
  • Required: No
  • User Property: asyncapi.generator.packageBase

skip:

Allows to skip the whole generation step
  • Type: boolean
  • Required: No
  • User Property: asyncapi.skip
  • Default: false

targetPath:

The path to generate the sources to
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/generated-sources/asyncapi