AsyncAPI - The Cheat Sheet
A bit more than two months ago, we've released the very first OpenAPI cheat sheet. Ever. We were really proud.
Since Bump.sh supports both OpenAPI and AsyncAPI (natively, with our own parsing and redering engine), there was just no reason for us not to also publish an AsyncAPI cheat sheet.
Lukasz Gornicki had actually already done a great job at building one. Yet, as the structure differed quite a bit from our OpenAPI version, it seemed relevant for us to make our own version.
The other upside was for nurturing our free knowledge base on API management. We could have homogeneous ways for the community to find key resources that let them better adopt both specifications, and documentation practices. More specifically, you'll find the cheat sheet right here.
Without further ado, let me introduce our AsyncAPI 3.0 Cheat Sheet:
For both cheat sheets, we had to make some decisions. For instance, we decided in the AsyncAPI one 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. There's a bunch more of our opinions that made it different from Lukasz's version.
It's open to feedback! Even if, despite the extreme care we gave it and some of our team member's hawk eyes, it's about the smallest typo we could have left. And contributing to it is possible just like for the OpenAPI version. It is CC BY-NC-SA 4.0 licensed, and the repo is right here. For now it will probably mostly be about opening issues to request changes (that's very welcome), as we've yet to build a version that can be edited directly from code.
We made that offer during apidays London. Let me extend it for apidays Paris: we're paying a drink to the first 5 people who drop by our booth with some feedback that will help make this cheat sheet better. Better: the cheat sheets (both versions, by the way), will be printed in A0 format and pinned to the OpenAPI and AsyncAPI conference room walls. We'll have some post-its and pins so that you can directly leave some suggestions, and have everybody review it together.
Share it with your network, the person working next to you or the world via social media; it's built for that!
