AsyncAPI explorer¶
Contract
Source:
doc/api/asyncapi.draft.yaml (2,296 lines)
The AsyncAPI draft can be rendered with the AsyncAPI HTML template at build time. While that's being wired in the build, this page links the raw spec for inspection:
- Raw spec:
/source/api/asyncapi.draft.yaml - Domain authoring fragments:
/source/api/asyncapi/*
What's in it¶
| Section | Contents |
|---|---|
info |
API title, version, contact |
servers |
NATS endpoints per environment |
channels |
Per-subject routing (provisioning.requested, etc.) |
operations |
Publish / subscribe semantics per channel |
components.messages |
Envelope + per-subject payload schemas |
components.schemas |
Reusable schema definitions |
components.securitySchemes |
mTLS configurations |
Streams ↔ subjects ↔ consumers¶
→ Read NATS subjects for the rendered matrix with payload tables and producer/consumer roles.
Rendering locally¶
# one-shot HTML render of the AsyncAPI doc
npx @asyncapi/html-template@latest \
generate fromTemplate \
doc/api/asyncapi.draft.yaml \
@asyncapi/html-template \
--output build/asyncapi-html
open build/asyncapi-html/index.html
Where to look next¶
- NATS subjects — the curated, fact-cited reference
- Outbox & event flow
- Contract workflow