About AsyncAPI
AsyncAPI is an open specification for describing event-driven and asynchronous APIs. It comes with open source tools for generating documentation and code from those descriptions.
What it does
The AsyncAPI specification lets you describe channels, messages and operations for systems that talk through events, such as message brokers. The project's tools use that description to generate HTML documentation, code in several languages and React components for docs. The project is part of the Linux Foundation and is governed openly by a community of contributors.
Key features
- Describe channels, messages and operations in one file
- Generate HTML documentation from a spec
- Generate code such as TypeScript, Java and C#
- Protocol-agnostic specification
Who it's for
- Teams building event-driven architectures
- Backend engineers working with message brokers
- Platform teams documenting event streams
Pricing and good to know
The specification repository is licensed under Apache-2.0, and the tools are open source as well. Using them costs nothing beyond the time it takes to set up the toolchain. Tools are installed separately, so check each one for its own requirements.
Highlights
- Describe channels, messages and operations in one file
- Generate HTML documentation from a spec
- Generate code such as TypeScript, Java and C#
- Protocol-agnostic specification
