AsyncAPI¶

OpenAPI focuses on HTTP-based, request/response-style APIs. If your application makes use of asynchronous APIs, you should consider documenting them using AsyncAPI.

AsyncAPI is an effort to provide a specification for message-driven APIs in a machine-readable format. It's protocol agnostic, among the supported ones: MQTT, AMQP, WebSockets, STOMP, Kafka

The AsyncAPI specification is based on OpenAPI 3, and tries to use as much as possible the same constructs and formats (e.g. data models with JSON Schema).