Skip to main content
Version: 1.6.0

AsyncAPI

AsyncAPI is an open-source specification for describing and documenting asynchronous APIs—APIs that rely on message-driven communication rather than synchronous request/response patterns like REST. It provides a standardized way to define how systems exchange messages through brokers or event buses using protocols such as MQTT, Kafka, AMQP, WebSockets, and more.

AsyncAPI 3.0 introduces a modernized, modular structure that enhances clarity and expressiveness when modeling event-driven systems. This facilitates automated documentation, code generation, and testing in microservices and IoT applications.

Core Concepts​

You can find an overview of AsyncAPI concepts in the official documentation.

Configuring an AsyncAPI Document​

hopit Edge allows you to configure an AsyncAPI 3.0.0 document with operations using the JSON Schema Viewer. The schema can be imported or exported using the respective buttons.

https://localhost:5050/Routes
AsyncAPI Schema Viewer

Configuring a Send Operation​

A send operation can be configured for each destination target once a valid AsyncAPI document is in place. The following example demonstrates how to configure a send operation and define an AsyncAPI channel parameter. In this example, the channel parameter corresponds to an MQTT topic.

https://localhost:5050/Routes
AsyncAPI Route Operation Configuration

Limitations​

  • Only AsyncAPI 3.0.0 documents in JSON format are currently supported.
  • The server definition is not supported, as servers are already defined in the hopit configuration (Targets).
  • Only send operations are currently supported.