Importare un documento AsyncAPI

AsyncAPI descrive le API guidate dagli eventi come OpenAPI descrive le API REST. Restorm ne ricava richieste di messaggistica.

Importare

File ▸ Importa (Ctrl+I) e poi il documento, in YAML o in JSON.

Che cosa viene importato

Elemento	Ciò che Restorm ne fa
Ogni canale	Una richiesta di pubblicazione e una richiesta di sottoscrizione, etichettate come tali
Il protocollo del server	Il tipo della richiesta prodotta (si veda più sotto)
Lo schema dei messaggi	Un payload di esempio costruito in base allo schema
Descrizioni	La documentazione di API

Le richieste vengono raggruppate in una cartella per protocollo.

Corrispondenza dei protocolli

Protocollo AsyncAPI	Richiesta Restorm prodotta
mqtt, mqtts	MQTT, con un prefisso di URL mqtt://
socketio, socket.io	Socket.IO
Tutto il resto	WebSocket, con un prefisso di URL ws://

Kafka e AMQP

I binding AsyncAPI Kafka e AMQP non producono richieste Kafka o AMQP: rientrano nella categoria «tutto il resto» e danno richieste WebSocket. Occorre creare queste richieste a mano dopo l’importazione — la struttura dei canali importata fornisce i topic e le code da riprendere.

Aggiornare

AsyncAPI fa parte dei formati risincronizzabili. Si veda Aggiornare dalla sorgente.