Learn¶

Each guide starts from an application in docs/examples/, shows the part of the AsyncAPI document it produces, and explains how one became the other. The test suite runs every example and validates its document against the official AsyncAPI schemas.

• Installation: install the plugin and serve a first document.
• Concepts and lifecycle: directions, channels, discovery sources and caching.
• WebSocket handlers: listeners, streams, raw sockets and Server-Sent Events.
• Decorators: explicit operations and messages on a handler.
• Schema generation: payload schemas, the Draft07 dialect, tuple bounds and examples.
• Exporting documents: write the document from the command line.
• Runnable examples: every example application in one place.

Broker topics, the documentation UI, security and mounting are covered under Integrations.