Effortlessly Generating Docs with AsyncAPI
summary
Shows how to go from specification to docs: install the CLI, write an AsyncAPI YAML (use YAML 1.2, mind case sensitivity), then run the generator to produce HTML. Uses a pizza-shop example with three events and three handlers to demonstrate what to document. Notes current limitations: AsyncAPI 3.0 CLI support is blocked by an open PR so use AsyncAPI 2.6 for CLI, markdown generation is broken, and AsyncAPI Studio can convert 2.6 specs to 3.2.
AI-written summary · about
chapters (11)
- 0:00AsyncAPI and docs generation
- 1:25How specs create docs
- 2:47Three-step doc generation
- 3:52AsyncAPI version and info
- 5:18Configuring servers
- 6:22Setting up channels
- 7:49Docs with AsyncAPI CLI
- 8:57AsyncAPI 3.0 limitations
- 10:49Converting 2.6 to 3.2
- 11:43Reviewing HTML docs
- 12:26Summary
related talks
28mHow AsyncAPI Docs Got a Facelift: GSoD 2022 Contributions
43mHow to contribute to AsyncAPI Dev Docs
26mContributing to AsyncAPI from a Technical Writer’s POV
21mLet there be docs!
21mMy Onboarding Experience as a New Docs Contributor to AsyncAPI
32mTransform Your OpenAPI Spec into Interactive, AI-Powered
35mDocumenting APIs: new era, same craft
47mDocumentation Is Fine, Don't Worry