Quarkus Asyncapi Scanner

This extension creates an AsyncApi-document, describing data your server publishes/subscribes to/from Kafka-topics.

It does this by

  • scanning for annotations @Channel, @Outgoing and @Incoming in your project,

  • reading topics and descriptions from microprofile-configuration and

  • reading data from running kafka

The result can be viewed as html or svg or downloaded as yaml, json or plant-uml (localhost://[quarkus.http.root-path]/asyncapi.[html|svg|yaml|json|puml]).

Installation

If you want to use this extension, you need to add the io.quarkiverse.asyncapi:quarkus-asyncapi extension first to your build file.

For instance, with Maven, add the following dependency to your POM file:

<dependency>
    <groupId>io.quarkiverse.asyncapi</groupId>
    <artifactId>quarkus-asyncapi-scanner</artifactId>
    <version>0.1.7</version>
</dependency>

Extension Configuration Reference

For more information about the extension configuration please refer to the Configuration Reference.

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

quarkus.asyncapi.annotation.scanner.enabled

Enable AysncApi-Scanning

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_ENABLED

boolean

true

quarkus.asyncapi.annotation.scanner.webcomponentversion

Version of the WebComponent to be used in html-view to be found at [HOST]/asyncapi.html

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_WEBCOMPONENTVERSION

string

1.0.0-next.47

quarkus.asyncapi.annotation.scanner.filter

Full qualified name of the implementing AsyncApiFilter

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_FILTER

string

quarkus.asyncapi.annotation.scanner.version

AsyncApi specification version

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_VERSION

string

2.6.0

quarkus.asyncapi.annotation.scanner.default-content-type

Default ContentType

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_DEFAULT_CONTENT_TYPE

string

application/json

quarkus.asyncapi.annotation.scanner.info.title

Title

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_INFO_TITLE

string

AsyncApi

quarkus.asyncapi.annotation.scanner.info.version

Project-version

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_INFO_VERSION

string

1.0.0

quarkus.asyncapi.annotation.scanner.info.description

Project-description

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_INFO_DESCRIPTION

string

quarkus.asyncapi.annotation.scanner.info.contact.name

Contact-Name

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_INFO_CONTACT_NAME

string

quarkus.asyncapi.annotation.scanner.info.contact.email

Contact-Email

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_INFO_CONTACT_EMAIL

string

you@mail.org

quarkus.asyncapi.annotation.scanner.info.contact.url

Contact-URL

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_INFO_CONTACT_URL

string

quarkus.asyncapi.annotation.scanner.info.license.name

License-Name

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_INFO_LICENSE_NAME

string

Commercial

quarkus.asyncapi.annotation.scanner.info.license.url

License-URL

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_INFO_LICENSE_URL

string

quarkus.asyncapi.annotation.scanner.server."server".url

Url

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_SERVER__SERVER__URL

string

required

quarkus.asyncapi.annotation.scanner.server."server".protocol

Protocol

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_SERVER__SERVER__PROTOCOL

string

kafka

quarkus.asyncapi.annotation.scanner.channel."channel".description

Description

Environment variable: QUARKUS_ASYNCAPI_ANNOTATION_SCANNER_CHANNEL__CHANNEL__DESCRIPTION

string