## File: README.md

[](https://www.asyncapi.com)

## Read the specification

The latest draft specification can be found at [spec/asyncapi.md](./spec/asyncapi.md) which tracks the latest commit to the master branch in this repository.

**The human-readable markdown file is the source of truth for the specification.**

- [Version 3.1.0](https://github.com/asyncapi/spec/blob/v3.1.0/spec/asyncapi.md) (latest) ([website](https://www.asyncapi.com/docs/reference/specification/latest))

  Click to see reference links to older versions of the specification.

- [Version 3.0.0](https://github.com/asyncapi/spec/blob/v3.0.0/spec/asyncapi.md)
- [Version 2.6.0](https://github.com/asyncapi/spec/blob/v2.6.0/spec/asyncapi.md)
- [Version 2.5.0](https://github.com/asyncapi/spec/blob/v2.5.0/spec/asyncapi.md)
- [Version 2.4.0](https://github.com/asyncapi/spec/blob/v2.4.0/spec/asyncapi.md)
- [Version 2.3.0](https://github.com/asyncapi/spec/blob/v2.3.0/spec/asyncapi.md)
- [Version 2.2.0](https://github.com/asyncapi/spec/blob/v2.2.0/spec/asyncapi.md)
- [Version 2.1.0](https://github.com/asyncapi/spec/blob/v2.1.0/spec/asyncapi.md)
- [Version 2.0.0](https://github.com/asyncapi/spec/blob/2.0.0/versions/2.0.0/asyncapi.md)
- [Version 1.2.0](https://github.com/asyncapi/spec/blob/1.2.0/README.md) (deprecated)
- [Version 1.1.0](https://github.com/asyncapi/spec/blob/1.1.0/README.md) (deprecated)
- [Version 1.0.0](https://github.com/asyncapi/spec/blob/1.0.0/README.md) (deprecated)




Looking for the JSON Schema files? Check out our [spec-json-schemas](https://github.com/asyncapi/spec-json-schemas) repo.

Feel like contributing? Check out our [contributor's guide](./CONTRIBUTING.md).

## Examples

Check out the [examples](https://github.com/asyncapi/asyncapi/blob/master/examples) directory for examples.

## Case Studies and Adopters

Check out the [AsyncAPI website](https://www.asyncapi.com/casestudies) to see the list of AsyncAPI adopters and their use cases.

## Our Sponsors

Want to become a sponsor? Learn [what we do with sponsors' money](https://www.asyncapi.com/finance) and [join the club](https://opencollective.com/asyncapi).

### Platinum

<a href="https://www.gravitee.io" target="_blank">
  
</a>

### Gold

<a href="https://solace.com/?utm_source=github&utm_medium=onlinereferral&utm_campaign=asyncapi_sponsorship" target="_blank">
  
</a>
&nbsp;&nbsp;&nbsp;&nbsp;  
<a href="https://ibm.com" target="_blank">
  
</a>

### Silver

<a href="https://www.svix.com/" target="_blank">
  
</a>



<a href="https://www.aklivity.io/" target="_blank">
  
</a>

### Bronze

<a href="https://www.apideck.com/" target="_blank">
  
</a>

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):






| [**Fran Méndez**](http://www.fmvilas.com)[💬](#question-fmvilas) [🐛](https://github.com/asyncapi/spec/issues?q=author%3Afmvilas) [📝](#blog-fmvilas) [📖](https://github.com/asyncapi/spec/commits?author=fmvilas) [🤔](#ideas-fmvilas) [🚇](#infra-fmvilas) [🚧](#maintenance-fmvilas) [👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Afmvilas) [✅](#tutorial-fmvilas) [📢](#talk-fmvilas) | [**Lukasz Gornicki**](http://resume.github.io/?derberg)[📖](https://github.com/asyncapi/spec/commits?author=derberg) [🤔](#ideas-derberg) [👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Aderberg) [💬](#question-derberg) [📝](#blog-derberg) [📢](#talk-derberg) [🚧](#maintenance-derberg) [🚇](#infra-derberg) | [**Mike Ralphson**](http://mermade.github.io)[💬](#question-MikeRalphson) [📖](https://github.com/asyncapi/spec/commits?author=MikeRalphson) [🤔](#ideas-MikeRalphson) [🚇](#infra-MikeRalphson) [👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3AMikeRalphson) [🚧](#maintenance-MikeRalphson) | [**raisel melian**](https://github.com/rmelian)[💬](#question-rmelian) [🐛](https://github.com/asyncapi/spec/issues?q=author%3Armelian) [📖](https://github.com/asyncapi/spec/commits?author=rmelian) [🤔](#ideas-rmelian) [🚧](#maintenance-rmelian) [👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Armelian) | [**Chris Wood**](https://github.com/SensibleWood)[🤔](#ideas-SensibleWood) [📖](https://github.com/asyncapi/spec/commits?author=SensibleWood) | [**Jonathan Schabowsky**](https://github.com/jschabowsky)[📖](https://github.com/asyncapi/spec/commits?author=jschabowsky) [🤔](#ideas-jschabowsky) | [**Victor Romero**](https://github.com/vromero)[🤔](#ideas-vromero) [👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Avromero) | [**Antonio Garrote**](http://antoniogarrote.wordpress.com)[🤔](#ideas-antoniogarrote) [👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Aantoniogarrote) [📖](https://github.com/asyncapi/spec/commits?author=antoniogarrote) | [**Jonathan Stoikovitch**](https://ramses.tech)[💡](#example-jstoiko) [🤔](#ideas-jstoiko) [👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Ajstoiko) |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| [**Jonas Lagoni**](https://github.com/jonaslagoni)[🐛](https://github.com/asyncapi/spec/issues?q=author%3Ajonaslagoni) [📖](https://github.com/asyncapi/spec/commits?author=jonaslagoni) [🤔](#ideas-jonaslagoni) [💬](#question-jonaslagoni) [👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Ajonaslagoni) [💡](#example-jonaslagoni) | [**Waleed Ashraf**](https://waleedashraf.me/)[📢](#talk-WaleedAshraf) [🤔](#ideas-WaleedAshraf) [📖](https://github.com/asyncapi/spec/commits?author=WaleedAshraf) [💡](#example-WaleedAshraf) | [**Andrzej Jarzyna**](https://github.com/jerzyn)[📢](#talk-jerzyn) | [**Emmelyn Wang**](https://linkedin.com/in/emmelyn)[📝](#blog-lifewingmate) [🤔](#ideas-lifewingmate) [📖](https://github.com/asyncapi/spec/commits?author=lifewingmate) [📢](#talk-lifewingmate) | [**Marc DiPasquale**](https://marcd.dev)[📝](#blog-Mrc0113) [📢](#talk-Mrc0113) [👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3AMrc0113) [🐛](https://github.com/asyncapi/spec/issues?q=author%3AMrc0113) [🤔](#ideas-Mrc0113) [📹](#video-Mrc0113) | [**Gerald Loeffler**](http://www.gerald-loeffler.net/)[📖](https://github.com/asyncapi/spec/commits?author=GeraldLoeffler) [🐛](https://github.com/asyncapi/spec/issues?q=author%3AGeraldLoeffler) [🤔](#ideas-GeraldLoeffler) | [**Dale Lane**](http://dalelane.co.uk/)[📝](#blog-dalelane) [🤔](#ideas-dalelane) [📹](#video-dalelane) [📢](#talk-dalelane) [✅](#tutorial-dalelane) [📖](https://github.com/asyncapi/spec/commits?author=dalelane) | [**Maciej Urbańczyk**](https://github.com/magicmatatjahu)[👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Amagicmatatjahu) [🤔](#ideas-magicmatatjahu) [💬](#question-magicmatatjahu) [🐛](https://github.com/asyncapi/spec/issues?q=author%3Amagicmatatjahu) [📖](https://github.com/asyncapi/spec/commits?author=magicmatatjahu) [💡](#example-magicmatatjahu) [🚧](#maintenance-magicmatatjahu) | [**Vladimir Gorej**](https://vladimirgorej.com/)[📖](https://github.com/asyncapi/spec/commits?author=char0n) [🐛](https://github.com/asyncapi/spec/issues?q=author%3Achar0n) [💡](#example-char0n) [🤔](#ideas-char0n) [👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Achar0n) |
| [**Lorna Jane Mitchell**](http://www.lornajane.net/)[📢](#talk-lornajane) [🤔](#ideas-lornajane) | [**Laurent Broudoux**](http://medium.com/@lbroudoux)[📖](https://github.com/asyncapi/spec/commits?author=lbroudoux) [📝](#blog-lbroudoux) [📢](#talk-lbroudoux) [💡](#example-lbroudoux) [🤔](#ideas-lbroudoux) [👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Albroudoux) | [**Jesse Menning**](https://github.com/jmenning-solace)[📝](#blog-jmenning-solace) [📢](#talk-jmenning-solace) [👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Ajmenning-solace) [🤔](#ideas-jmenning-solace) | [**Sergio Moya**](https://github.com/smoya)[👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Asmoya) [🤔](#ideas-smoya) [💬](#question-smoya) [📝](#blog-smoya) [🐛](https://github.com/asyncapi/spec/issues?q=author%3Asmoya) [📖](https://github.com/asyncapi/spec/commits?author=smoya) [💡](#example-smoya) [🚧](#maintenance-smoya) | [**Alexander Balogh**](https://github.com/balogal)[📖](https://github.com/asyncapi/spec/commits?author=balogal) [🐛](https://github.com/asyncapi/spec/issues?q=author%3Abalogal) | [**Khuda Dad Nomani**](https://github.com/KhudaDad414)[💡](#example-KhudaDad414) [🐛](https://github.com/asyncapi/spec/issues?q=author%3AKhudaDad414) | [**Aaron Korver**](https://github.com/aaronkorver)[📖](https://github.com/asyncapi/spec/commits?author=aaronkorver) | [**Orlov Valentine**](https://github.com/xunto)[📖](https://github.com/asyncapi/spec/commits?author=xunto) | [**Moez Bouhlel**](https://lejenome.tik.tn)[📖](https://github.com/asyncapi/spec/commits?author=lejenome) |
| [**Muhammad Rafly Andrianza**](https://github.com/luphieanza)[📖](https://github.com/asyncapi/spec/commits?author=luphieanza) | [**Daniel Kocot**](https://danielkocot.github.io/)[📖](https://github.com/asyncapi/spec/commits?author=danielkocot) [💡](#example-danielkocot) [🤔](#ideas-danielkocot) | [**sekharbans-ebay**](https://github.com/sekharbans-ebay)[📖](https://github.com/asyncapi/spec/commits?author=sekharbans-ebay) [💡](#example-sekharbans-ebay) [🤔](#ideas-sekharbans-ebay) | [**Michael Davis**](http://www.damaru.com/)[🐛](https://github.com/asyncapi/spec/issues?q=author%3Adamaru-inc) [📖](https://github.com/asyncapi/spec/commits?author=damaru-inc) [💡](#example-damaru-inc) [🤔](#ideas-damaru-inc) | [**Heiko Henning**](https://github.com/GreenRover)[🐛](https://github.com/asyncapi/spec/issues?q=author%3AGreenRover) [💻](https://github.com/asyncapi/spec/commits?author=GreenRover) [🖋](#content-GreenRover) [📖](https://github.com/asyncapi/spec/commits?author=GreenRover) [💡](#example-GreenRover) [🤔](#ideas-GreenRover) [🚧](#maintenance-GreenRover) [👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3AGreenRover) | [**Quetzalli **](http://www.docsasecosystem.com)[🖋](#content-alequetzalli) [📖](https://github.com/asyncapi/spec/commits?author=alequetzalli) [💡](#example-alequetzalli) [🤔](#ideas-alequetzalli) [👀](https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Aalequetzalli) | [**Akshit Gupta**](https://github.com/akkshitgupta)[🖋](#content-akkshitgupta) [📖](https://github.com/asyncapi/spec/commits?author=akkshitgupta) | [**samz**](https://amzani.com/)[🐛](https://github.com/asyncapi/spec/issues?q=author%3AAmzani) [🖋](#content-Amzani) [📖](https://github.com/asyncapi/spec/commits?author=Amzani) [💡](#example-Amzani) [📆](#projectManagement-Amzani) | [**Rishi**](http://rishikaushik.com)[🚧](#maintenance-kaushik-rishi) [🚇](#infra-kaushik-rishi) |
| [**nickshoe**](https://github.com/nickshoe)[🐛](https://github.com/asyncapi/spec/issues?q=author%3Anickshoe) [📖](https://github.com/asyncapi/spec/commits?author=nickshoe) | [**Ace **](https://github.com/AceTheCreator)[📋](#eventOrganizing-AceTheCreator) [🤔](#ideas-AceTheCreator) [🚧](#maintenance-AceTheCreator) [📢](#talk-AceTheCreator) | [**Animesh Kumar**](https://github.com/AnimeshKumar923)[🖋](#content-AnimeshKumar923) [📖](https://github.com/asyncapi/spec/commits?author=AnimeshKumar923) [🚧](#maintenance-AnimeshKumar923) | [**Fabrizio Lazzaretti**](https://lazzaretti.me/)[📖](https://github.com/asyncapi/spec/commits?author=Lazzaretti) | [**Pavel Bodiachevskii**](https://www.linkedin.com/in/pavel-bo/)[📖](https://github.com/asyncapi/spec/commits?author=Pakisan) [🐛](https://github.com/asyncapi/spec/issues?q=author%3APakisan) [🤔](#ideas-Pakisan) [💬](#question-Pakisan) |  |  |  |  |








This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

---

## File: examples/social-media/readme.md

## Small social media example

Say we have a social network, a very basic one, where all you can do is upvoting comments.

The individual services are defined as such:

- [A frontend application (./frontend)](./frontend/asyncapi.yaml) where users interact through the website, where they can like comments.
- [A backend WebSocket server (./backend)](./backend/asyncapi.yaml) that sends and receives events for the UI to update in real-time.
- [A comment service (./comments-service)](./comments-service/asyncapi.yaml) which processes all events related to comments through a message broker.
- [A notification service (./notification-service)](./notification-service/asyncapi.yaml) which ensures all relevant parties to the comment is notified.
- [A public-facing API (./public-api)](./public-api/asyncapi.yaml) which is an external application, where anyone outside the organization can get notified about updates.


[](https://mermaid-js.github.io/mermaid-live-editor/edit/#eyJjb2RlIjoiXG5ncmFwaCBURFxuIHNlcnZlcjFbKHdzOi8vbXljb21wYW55LmNvbS93cyldXG5XZWJzaXRlQmFja2VuZFtXZWJzaXRlIEJhY2tlbmRdXG5XZWJzaXRlV2ViU29ja2V0Q2xpZW50W1dlYnNpdGUgV2ViU29ja2V0IENsaWVudF1cbldlYnNpdGVXZWJTb2NrZXRDbGllbnQgLS0gbGlrZS9jb21tZW50IC0tPiBzZXJ2ZXIxXG5zZXJ2ZXIxIC0tIGxpa2UvY29tbWVudCAtLT4gV2Vic2l0ZUJhY2tlbmRcbldlYnNpdGVCYWNrZW5kIC0tIHVwZGF0ZS9jb21tZW50L2xpa2VzIC0tPiBzZXJ2ZXIxXG5zZXJ2ZXIxIC0tIHVwZGF0ZS9jb21tZW50L2xpa2VzIC0tPiBXZWJzaXRlV2ViU29ja2V0Q2xpZW50XG5zZXJ2ZXIyWyhtcXR0Oi8vdGVzdC5tb3NxdWl0dG8ub3JnKV1cbldlYnNpdGVCYWNrZW5kIC0tIGNvbW1lbnQvbGlrZWQgLS0-IHNlcnZlcjJcbkNvbW1lbnRzU2VydmljZVtDb21tZW50cyBTZXJ2aWNlXVxuc2VydmVyMiAtLSBjb21tZW50L2xpa2VkIC0tPiBDb21tZW50c1NlcnZpY2Vcbk5vdGlmaWNhdGlvbnNTZXJ2aWNlW05vdGlmaWNhdGlvbnMgU2VydmljZV1cbnNlcnZlcjIgLS0gY29tbWVudC9saWtlZCAtLT4gTm90aWZpY2F0aW9uc1NlcnZpY2VcbkNvbW1lbnRzU2VydmljZSAtLSBcImNvbW1lbnQve2NvbW1lbnRJZH0vY2hhbmdlZFwiIC0tPiBzZXJ2ZXIyXG5zZXJ2ZXIyIC0tIFwiY29tbWVudC97Y29tbWVudElkfS9jaGFuZ2VkXCIgLS0-IFdlYnNpdGVCYWNrZW5kXG5QdWJsaWNBUElbUHVibGljIEFQSV1cbnNlcnZlcjIgLS0gXCJjb21tZW50L2xpa2VkXCIgLS0-IFB1YmxpY0FQSSIsIm1lcm1haWQiOiJ7XG4gIFwidGhlbWVcIjogXCJkYXJrXCJcbn0iLCJ1cGRhdGVFZGl0b3IiOmZhbHNlLCJhdXRvU3luYyI6dHJ1ZSwidXBkYXRlRGlhZ3JhbSI6ZmFsc2V9)


Fig.1 - Mermaid diagram for the system, partly generated using [Cupid](https://github.com/asyncapi/cupid).


This ensures that we try to describe the following use-cases mixed together:

- A public API, and how others may interact with our system.
- A broker setup to include the most widely used scenario
- A WebSocket server and client to ensure we dont focus only on broker centric systems.
- Reusability where possible, to ensure no dublication of definitions

---

## File: examples/README.md

# Examples

In this directory, you can find some examples of AsyncAPI documents.

**Do you have an example that could be valuable?** Open a pull request to contribute it.

## File naming

You may notice `asyncapi` in the the name of each example. We recommend doing the same with your AsyncAPI document. This way you enable features like documentation display on node hover, auto completion and validation of your AsyncAPI documents in IDEs like VSCode or IntelliJ IDEA. IDEs integrate with [SchemaStore](https://www.schemastore.org/json/) where AsyncAPI specification JSON Schema files are referenced. Some IDEs do it by default, some, like VSCode require you to install additional extensions, like `YAML` extension.

## Editors

To edit your AsyncAPI documents, you can use [AsyncAPI Studio](https://studio.asyncapi.com/).

If you prefer to use your favourite IDE, there are official extensions for [VSCode](https://marketplace.visualstudio.com/items?itemName=asyncapi.asyncapi-preview) and [IntelliJ IDEA](https://plugins.jetbrains.com/plugin/15673-asyncapi)