Importing an AsyncAPI document

AsyncAPI describes event-driven APIs the way OpenAPI describes REST APIs. Restorm turns it into messaging requests.

Importing

File ▸ Import (Ctrl+I) then the document, in YAML or in JSON.

What is imported

Element	What Restorm makes of it
Each channel	A publish request and a subscribe request, tagged as such
The server’s protocol	The type of request produced (see below)
The messages’ schema	A sample payload built from the schema
Descriptions	The API documentation

The requests are grouped into one folder per protocol.

Protocol mapping

AsyncAPI protocol	Restorm request produced
mqtt, mqtts	MQTT, with an mqtt:// URL prefix
socketio, socket.io	Socket.IO
Everything else	WebSocket, with a ws:// URL prefix

Kafka and AMQP

The AsyncAPI Kafka and AMQP bindings do not produce Kafka or AMQP requests: they fall into the “everything else” category and yield WebSocket requests. Create those requests by hand after the import — the imported channel structure gives you the topics and queues to work from.

Updating

AsyncAPI is one of the re-syncable formats. See Updating from the source.