Live demo

Everything on this page is rendered by asyncapi-viewer from the two example documents in docs/examples/. The Markdown for each section is shown above its viewer.

AsyncAPI 3 document (YAML), fenced-block syntax

```asyncapi
src: examples/orders-v3.yaml
sendLabel: EMIT
receiveLabel: ON
```

AsyncAPI 2 document (JSON), element syntax, sidebar grouped by tags

The sidebar is off by default. With sidebar="true" in a narrow column it sits behind the round toggle button at the top right of the viewer.

<asyncapi-viewer src="examples/accounts-v2.json" sidebar="true" showServers="bySpecTags" showOperations="bySpecTags" messageExamples="false"></asyncapi-viewer>

Error handling (this one is meant to fail)

The tag below points at a host that does not exist, to show what readers see when a document cannot be loaded: a message in place of the viewer, naming the URL, instead of a blank box. A wrong local path is caught earlier, at build time, because mkdocs build --strict fails on it.

<asyncapi-viewer src="https://example.invalid/asyncapi.yaml"></asyncapi-viewer>