shanerogers/spec

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

JavaScriptApache-2.0

🙌 Platinum sponsors. Join them! 🙌

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.

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 Events API

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

👉 See more

Gitter Streaming API

Definition of the Gitter streaming API.

👉 See more

Gemini WebSocket API

Definition of the Gemini Websocket API.

👉 See more

➕ and more...

Check out the examples directory for more examples.

Contributors

Thanks goes to these wonderful people (emoji key):

_{Fran Méndez} 💬 🐛 📝 📖 🤔 🚇 🚧 👀 ✅ 📢	_{Lukasz Gornicki} 📖 🤔 👀 💬 📝 📢 🚧 🚇	_{Mike Ralphson} 💬 📖 🤔 🚇 👀 🚧	_{raisel melian} 💬 🐛 📖 🤔 🚧 👀	_{Chris Wood} 🤔 📖	_{Jonathan Schabowsky} 📖 🤔	_{Victor Romero} 🤔 👀	_{Antonio Garrote} 🤔 👀 📖	_{Jonathan Stoikovitch} 💡 🤔 👀
_{Jonas Lagoni} 🐛 📖 🤔 💬 👀 💡	_{Waleed Ashraf} 📢 🤔 📖 💡	_{Andrzej Jarzyna} 📢	_{Emmelyn Wang} 📝 🤔 📖 📢	_{Marc DiPasquale} 📝 📢 👀 🐛 🤔 📹	_{Gerald Loeffler} 📖 🐛 🤔	_{Dale Lane} 📝 🤔 📹 📢 ✅ 📖	_{Maciej Urbańczyk} 👀 🤔 💬 🐛 📖 💡 🚧	_{Vladimir Gorej} 📖 🐛 💡 🤔 👀
_{Lorna Jane Mitchell} 📢 🤔	_{Laurent Broudoux} 📖 📝 📢 💡 🤔 👀	_{Jesse Menning} 📝 📢 👀 🤔	_{Sergio Moya} 👀 🤔 💬 📝 🐛 📖 💡 🚧	_{Alexander Balogh} 📖 🐛	_{Khuda Dad Nomani} 💡 🐛	_{Aaron Korver} 📖	_{Orlov Valentine} 📖	_{Moez Bouhlel} 📖
_{Muhammad Rafly Andrianza} 📖	_{Daniel Kocot} 📖 💡 🤔	_{sekharbans-ebay} 📖 💡 🤔	_{Michael Davis} 🐛 📖 💡 🤔

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