Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add AsyncAPI Cheat Sheet #308

Merged
merged 1 commit into from
Nov 29, 2024
Merged

Add AsyncAPI Cheat Sheet #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/_data/authors.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ chris:
name: Christophe Dujarric
title: Head of PM
github: https://github.com/ChristopheDujarric
image_url: https://bump.sh/packs/static/chris-dujarric-ee8962c988131c701834.png
image_url: https://avatars.githubusercontent.com/u/7700560
email: [email protected]

polo:
Expand Down
32 changes: 32 additions & 0 deletions src/_guides/asyncapi/cheatsheet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: AsyncAPI 3.0 - The Cheat Sheet
authors: chris
excerpt: Everything you need to keep in mind when writing an AsyncAPI contract, on a one-pager.
date: 2024-11-29
---

AsyncAPI, as per the [official documentation site](https://www.asyncapi.com/docs/concepts), 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](_guides/openapi/specification/v3.1/cheatsheet.md), we wanted to write our own AsyncAPI Cheat Sheet:

![asyncapi-30-cheatsheet-v1.png](https://storage.googleapis.com/bump-blog-resources/asyncapi-30-cheatsheet/asyncapi-30-cheatsheet-v1.png)
[Download the PDF version](https://storage.googleapis.com/bump-blog-resources/asyncapi-30-cheatsheet/asyncapi-30-cheatsheet-v1.pdf)

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](https://github.com/bump-sh/docs/issues). 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.