API & Specs · AsyncAPI macro
Everyone who builds against your events can read the contract
With the AsyncAPI macro the spec that only its authors ever opened becomes a readable reference on the Confluence page. Everyone integrating with your Kafka topics, MQTT channels or WebSocket messages reads the contract where they already look - and stops asking your team what a topic sends.
You stop answering "what does this topic send?"
Message-based architectures have no browsable URL to poke at, so the spec is the only contract there is. Rendered on the page it does the answering for you: channels, operations and message schemas laid out with a sidebar to move between them, instead of a YAML file passed around in chat and a question in your inbox.
New teams integrate from the page, not from a call with you
Readers expand the message examples and see the actual shape of what travels on the channel - the thing they were going to ask you for anyway. A new team builds against your system from the page rather than from a meeting with whoever remembers the schema.
The spec on the page is always the spec you ship
Point the macro at the AsyncAPI document where it already lives - your repository over a URL or a GitHub, GitLab or Bitbucket connection, a page attachment, Google Drive, or an S3 bucket, SFTP server or database connection an admin set up once. JSON or YAML, either is fine, and your page references the spec rather than a copy that drifts a release behind.
Your documentation cannot describe a channel that no longer exists
Because the page renders from the spec, it cannot go stale the way hand-written prose does, so your architects keep trusting it. Links in the rendered spec open in a new tab by default, so nobody loses their place in your document, and you switch the sidebar off when a compact embed reads better than a full reference.
What the other AsyncAPI app leaves you maintaining by hand
Only a handful of Marketplace apps render AsyncAPI at all, and the one built for it asks you to author the spec inside Confluence, in a YAML editor on the page. That leaves you with a second copy of the contract, maintained by hand, diverging from the one your services are actually built against. This macro renders the spec your build already publishes - from the repository over a URL or a GitHub, GitLab or Bitbucket connection, from Google Drive, from an S3 bucket, an SFTP server or a database an admin connected once - so your page cannot describe a channel your system stopped sending.
AsyncAPI is one of 31 macros in Macro Pack
One app to install, one licence to renew, one place your team learns - and 30 more formats it already reads, from spreadsheets and diagrams to API specs and documents.
See every macro in the pack