Spec

Read the specification

The latest draft specification can be found at 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 (latest) (website)

<details> <summary>Click to see reference links to older versions of the specification.</summary>

• Version 3.0.0
• Version 2.6.0
• Version 2.5.0
• Version 2.4.0
• Version 2.3.0
• Version 2.2.0
• Version 2.1.0
• Version 2.0.0
• Version 1.2.0 (deprecated)
• Version 1.1.0 (deprecated)
• Version 1.0.0 (deprecated)

</details> </br>

Looking for the JSON Schema files? Check out our spec-json-schemas repo.

Feel like contributing? Check out our contributor's guide.

Examples

Check out the examples directory for examples.

Case Studies and Adopters

Check out the AsyncAPI website 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 and join the club.

Platinum

<a href="https://www.gravitee.io" target="_blank"> <img src="./assets/Gravitee.png" alt="Gravitee" height="70"> </a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="https://konghq.com/" target="_blank"> <img src="./assets/kong.png" alt="Kong" height="90"> </a>

Gold

<a href="https://solace.com/?utm_source=github&utm_medium=onlinereferral&utm_campaign=asyncapi_sponsorship" target="_blank"> <img src="./assets/solace.png" alt="Solace: powering event-driven architectures, integrations and AI" height="70"> </a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="https://ibm.com" target="_blank"> <img src="./assets/ibm.png" alt="IBM" height="70"> </a>

Silver

<a href="https://bump.sh/asyncapi?utm_source=asyncapi&utm_medium=github_readme&utm_campaign=sponsor" target="_blank"> <img src="./assets/bump-sh-white-bg.png" alt="Bump.sh" height="70"> </a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="https://www.svix.com/" target="_blank"> <img src="./assets/svix.png" alt="Svix" height="70"> </a> <br/> <a href="https://www.aklivity.io/" target="_blank"> <img src="./assets/aklivity.png" alt="Aklivity" height="70"> </a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="https://smartbear.com" target="_blank"> <img src="./assets/smartbear.png" alt="SmartBear" height="70"> </a> <br/> <a href="https://route4me.com" target="_blank"> <img src="./assets/route4me.png" alt="Best Route Planning and Route Optimization Software" height="70"> </a>

Bronze

<a href="https://www.apideck.com/" target="_blank"> <img src="./assets/apideck.png" alt="APIDeck" height="30"> </a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="https://opensource.mercedes-benz.com/" target="_blank"> <img src="./assets/mercedes-benz.png" alt="Mercedes Benz" height="70"> </a>

Contributors

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="11.11%"><a href="http://www.fmvilas.com"><img src="https://avatars3.githubusercontent.com/u/242119?v=4?s=100" width="100px;" alt="Fran Méndez"/><br />_{<b>Fran Méndez</b>}</a><br /><a href="#question-fmvilas" title="Answering Questions">💬</a> <a href="https://github.com/asyncapi/spec/issues?q=author%3Afmvilas" title="Bug reports">🐛</a> <a href="#blog-fmvilas" title="Blogposts">📝</a> <a href="https://github.com/asyncapi/spec/commits?author=fmvilas" title="Documentation">📖</a> <a href="#ideas-fmvilas" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-fmvilas" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-fmvilas" title="Maintenance">🚧</a> <a href="https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Afmvilas" title="Reviewed Pull Requests">👀</a> <a href="#tutorial-fmvilas" title="Tutorials">✅</a> <a href="#talk-fmvilas" title="Talks">📢</a></td> <td align="center" valign="top" width="11.11%"><a href="http://resume.github.io/?derberg"><img src="https://avatars1.githubusercontent.com/u/6995927?v=4?s=100" width="100px;" alt="Lukasz Gornicki"/><br />_{<b>Lukasz Gornicki</b>}</a><br /><a href="https://github.com/asyncapi/spec/commits?author=derberg" title="Documentation">📖</a> <a href="#ideas-derberg" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Aderberg" title="Reviewed Pull Requests">👀</a> <a href="#question-derberg" title="Answering Questions">💬</a> <a href="#blog-derberg" title="Blogposts">📝</a> <a href="#talk-derberg" title="Talks">📢</a> <a href="#maintenance-derberg" title="Maintenance">🚧</a> <a href="#infra-derberg" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td> <td align="center" valign="top" width="11.11%"><a href="http://mermade.github.io"><img src="https://avatars0.githubusercontent.com/u/21603?v=4?s=100" width="100px;" alt="Mike Ralphson"/><br />_{<b>Mike Ralphson</b>}</a><br /><a href="#question-MikeRalphson" title="Answering Questions">💬</a> <a href="https://github.com/asyncapi/spec/commits?author=MikeRalphson" title="Documentation">📖</a> <a href="#ideas-MikeRalphson" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-MikeRalphson" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3AMikeRalphson" title="Reviewed Pull Requests">👀</a> <a href="#maintenance-MikeRalphson" title="Maintenance">🚧</a></td> <td align="center" valign="top" width="11.11%"><a href="https://github.com/rmelian"><img src="https://avatars3.githubusercontent.com/u/4565267?v=4?s=100" width="100px;" alt="raisel melian"/><br />_{<b>raisel melian</b>}</a><br /><a href="#question-rmelian" title="Answering Questions">💬</a> <a href="https://github.com/asyncapi/spec/issues?q=author%3Armelian" title="Bug reports">🐛</a> <a href="https://github.com/asyncapi/spec/commits?author=rmelian" title="Documentation">📖</a> <a href="#ideas-rmelian" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-rmelian" title="Maintenance">🚧</a> <a href="https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Armelian" title="Reviewed Pull Requests">👀</a></td> <td align="center" valign="top" width="11.11%"><a href="https://github.com/SensibleWood"><img src="https://avatars2.githubusercontent.com/u/2420069?v=4?s=100" width="100px;" alt="Chris Wood"/><br />_{<b>Chris Wood</b>}</a><br /><a href="#ideas-SensibleWood" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/asyncapi/spec/commits?author=SensibleWood" title="Documentation">📖</a></td> <td align="center" valign="top" width="11.11%"><a href="https://github.com/jschabowsky"><img src="https://avatars1.githubusercontent.com/u/26606293?v=4?s=100" width="100px;" alt="Jonathan Schabowsky"/><br />_{<b>Jonathan Schabowsky</b>}</a><br /><a href="https://github.com/asyncapi/spec/commits?author=jschabowsky" title="Documentation">📖</a> <a href="#ideas-jschabowsky" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center" valign="top" width="11.11%"><a href="https://github.com/vromero"><img src="https://avatars1.githubusercontent.com/u/1119553?v=4?s=100" width="100px;" alt="Victor Romero"/><br />_{<b>Victor Romero</b>}</a><br /><a href="#ideas-vromero" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Avromero" title="Reviewed Pull Requests">👀</a></td> <td align="center" valign="top" width="11.11%"><a href="http://antoniogarrote.wordpress.com"><img src="https://avatars1.githubusercontent.com/u/8277?v=4?s=100" width="100px;" alt="Antonio Garrote"/><br />_{<b>Antonio Garrote</b>}</a><br /><a href="#ideas-antoniogarrote" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Aantoniogarrote" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/asyncapi/spec/commits?author=antoniogarrote" title="Documentation">📖</a></td> <td align="center" valign="top" width="11.11%"><a href="https://ramses.tech"><img src="https://avatars0.githubusercontent.com/u/9660342?v=4?s=100" width="100px;" alt="Jonathan Stoikovitch"/><br />_{<b>Jonathan Stoikovitch</b>}</a><br /><a href="#example-jstoiko" title="Examples">💡</a> <a href="#ideas-jstoiko" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/asyncapi/spec/pulls?q=is%3Apr+reviewed-by%3Ajstoiko" title="Reviewed Pull Requests">👀</a></td> </tr> <tr> <td align="center" valign="top" width="11.11%"><a href="https://github.com/jonaslagoni"><img src="https://avat