Een AsyncAPI-document importeren

AsyncAPI beschrijft eventgestuurde API’s zoals OpenAPI REST-API’s beschrijft. Restorm maakt daar messagingverzoeken van.

Importeren

Bestand ▸ Importeren (Ctrl+I) en daarna het document, in YAML of in JSON.

Wat er wordt geïmporteerd

Element	Wat Restorm daarmee doet
Elk kanaal	Een publicatieverzoek en een abonnementsverzoek, als zodanig gelabeld
Het protocol van de server	Het type van het verzoek dat wordt gemaakt (zie hieronder)
Het schema van de berichten	Een voorbeeldpayload, opgebouwd naar het schema
Beschrijvingen	De API-documentatie

De verzoeken worden per protocol in een map gegroepeerd.

Overeenkomst tussen de protocollen

AsyncAPI-protocol	Restorm-verzoek dat wordt gemaakt
mqtt, mqtts	MQTT, met een URL-voorvoegsel mqtt://
socketio, socket.io	Socket.IO
Al het overige	WebSocket, met een URL-voorvoegsel ws://

Kafka en AMQP

De AsyncAPI-bindings voor Kafka en AMQP leveren geen Kafka- of AMQP-verzoeken op: ze vallen in de categorie “al het overige” en geven WebSocket-verzoeken. Maak die verzoeken na de import met de hand aan — de geïmporteerde kanaalstructuur geeft u de topics en wachtrijen die u kunt overnemen.

Bijwerken

AsyncAPI hoort bij de formaten die opnieuw te synchroniseren zijn. Zie Bijwerken vanaf de bron.