AsyncAPI How-To

AsyncAPI is an open-source specification for describing and documenting event-driven APIs. AsyncAPI 3.1 is a release of AsyncAPI 3 that adds bindings for Robot Operating System 2 (ROS 2).

For the versions and features that Swagger Studio supports, see AsyncAPI Support.

The AsyncAPI website provides tutorials and a full specification for AsyncAPI:

Coming from OpenAPI - comparing/contrasting OpenAPI and AsyncAPI

Getting Started with AsyncAPI

Streetlights Tutorial

If you are using OpenAPI 2.0 (Swagger 2.0), see this tutorial instead. If you are using OpenAPI 3.0, see this tutorial instead.