/asyncapi

The AsyncAPI specification allows you to create machine-readable definitions of your asynchronous APIs.

Primary LanguageJavaScriptApache License 2.0Apache-2.0

AsyncAPI Logo


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.

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

Feel like contributing? Check out our community repo.

Examples

πŸ’‘ Streetlights

Demonstrates how to use AsyncAPI to define an API that controls city streetlights.

πŸ‘‰ See more

Slack icon   Slack Events API

Partial definition of the Slack Events API. Find the official one here.

πŸ‘‰ See more

Gitter icon   Gitter Streaming API

Definition of the Gitter streaming API.

πŸ‘‰ See more

Gemini icon   Gemini WebSocket API

Definition of the Gemini Websocket API.

πŸ‘‰ See more

βž• and more...

Check out the examples directory for more examples.

Our Sponsors

Platinum

Solace logo      IBM logo      Postman logo

Gold

RedHat logo     

Silver

Bump.sh logo      swix logo     

Bronze

ably.png logo      rviewer.png logo     

Contributors

Thanks goes to these wonderful people (emoji key):

Fran MΓ©ndez
Fran MΓ©ndez

πŸ’¬ πŸ› πŸ“ πŸ“– πŸ€” πŸš‡ 🚧 πŸ‘€ βœ… πŸ“’
Lukasz Gornicki
Lukasz Gornicki

πŸ“– πŸ€” πŸ‘€ πŸ’¬ πŸ“ πŸ“’ 🚧 πŸš‡
Mike Ralphson
Mike Ralphson

πŸ’¬ πŸ“– πŸ€” πŸš‡ πŸ‘€ 🚧
raisel melian
raisel melian

πŸ’¬ πŸ› πŸ“– πŸ€” 🚧 πŸ‘€
Chris Wood
Chris Wood

πŸ€” πŸ“–
Jonathan Schabowsky
Jonathan Schabowsky

πŸ“– πŸ€”
Victor Romero
Victor Romero

πŸ€” πŸ‘€
Antonio Garrote
Antonio Garrote

πŸ€” πŸ‘€ πŸ“–
Jonathan Stoikovitch
Jonathan Stoikovitch

πŸ’‘ πŸ€” πŸ‘€
Jonas Lagoni
Jonas Lagoni

πŸ› πŸ“– πŸ€” πŸ’¬ πŸ‘€ πŸ’‘
Waleed Ashraf
Waleed Ashraf

πŸ“’ πŸ€” πŸ“– πŸ’‘
Andrzej Jarzyna
Andrzej Jarzyna

πŸ“’
Emmelyn Wang
Emmelyn Wang

πŸ“ πŸ€” πŸ“– πŸ“’
Marc DiPasquale
Marc DiPasquale

πŸ“ πŸ“’ πŸ‘€ πŸ› πŸ€” πŸ“Ή
Gerald Loeffler
Gerald Loeffler

πŸ“– πŸ› πŸ€”
Dale Lane
Dale Lane

πŸ“ πŸ€” πŸ“Ή πŸ“’ βœ… πŸ“–
Maciej UrbaΕ„czyk
Maciej UrbaΕ„czyk

πŸ‘€ πŸ€” πŸ’¬ πŸ› πŸ“– πŸ’‘ 🚧
Vladimir Gorej
Vladimir Gorej

πŸ“– πŸ› πŸ’‘ πŸ€” πŸ‘€
Lorna Jane Mitchell
Lorna Jane Mitchell

πŸ“’ πŸ€”
Laurent Broudoux
Laurent Broudoux

πŸ“– πŸ“ πŸ“’ πŸ’‘ πŸ€” πŸ‘€
Jesse Menning
Jesse Menning

πŸ“ πŸ“’ πŸ‘€ πŸ€”
Sergio Moya
Sergio Moya

πŸ‘€ πŸ€” πŸ’¬ πŸ“ πŸ› πŸ“– πŸ’‘ 🚧
Alexander Balogh
Alexander Balogh

πŸ“– πŸ›
Khuda Dad Nomani
Khuda Dad Nomani

πŸ’‘ πŸ›
Aaron Korver
Aaron Korver

πŸ“–
Orlov Valentine
Orlov Valentine

πŸ“–
Moez Bouhlel
Moez Bouhlel

πŸ“–
Muhammad Rafly Andrianza
Muhammad Rafly Andrianza

πŸ“–
Daniel Kocot
Daniel Kocot

πŸ“– πŸ’‘ πŸ€”
sekharbans-ebay
sekharbans-ebay

πŸ“– πŸ’‘ πŸ€”
Michael Davis
Michael Davis

πŸ› πŸ“– πŸ’‘ πŸ€”
Heiko Henning
Heiko Henning

πŸ› πŸ’» πŸ–‹ πŸ“– πŸ’‘ πŸ€” 🚧 πŸ‘€
Quetzalli
Quetzalli

πŸ–‹ πŸ“– πŸ’‘ πŸ€” πŸ‘€
Akshit Gupta
Akshit Gupta

πŸ–‹ πŸ“–
samz
samz

πŸ› πŸ–‹ πŸ“– πŸ’‘ πŸ“†
Rishi
Rishi

🚧 πŸš‡
nickshoe
nickshoe

πŸ› πŸ“–
Ace
Ace

πŸ“‹ πŸ€” 🚧 πŸ“’
Animesh Kumar
Animesh Kumar

πŸ–‹ πŸ“– 🚧
Fabrizio Lazzaretti
Fabrizio Lazzaretti

πŸ“–

This project follows the all-contributors specification. Contributions of any kind welcome!