AsyncAPI 3.0 - The Cheat Sheet
AsyncAPI, as per the official documentation site, is an open source initiative that seeks to improve the current state of Event-Driven Architectures (EDA). Our long-term goal is to make working with EDAs as easy as working with REST APIs. That goes from documentation to code generation, from discovery to event management, and beyond.
Their sites offers extensive guides and tutorials, as well as the reference documentation of the AsyncAPI specification.
As we have built one for OpenAPI, we wanted to write our own AsyncAPI Cheat Sheet:
The Cheat Sheet is presented here in an initial version. We decided to have examples only in JSON Schema and Avro, which felt to us covering the majority of use cases we saw from Bump.sh users, at least.
Here are the current sections:
- Document Structure
- General Information
- Security
- Channels
- Operations
- Messages
- Schemas
- Protocal Bindings
- Reuse Elements
- Polymorphism
For any feedback and suggestions, please open an issue on our GitHub Repository. We are currently working on building a web version of the Cheat Sheet, so that anyone can directly contribute to it with a Pull Request.