Import dokumentu AsyncAPI

AsyncAPI opisuje API zdarzeniowe tak, jak OpenAPI opisuje API REST. Restorm tworzy na tej podstawie żądania komunikacyjne.

Importowanie

Plik ▸ Importuj (Ctrl+I), a następnie dokument w formacie YAML lub JSON.

Co zostaje zaimportowane

Element	Co Restorm z tego tworzy
Każdy kanał	Żądanie publikacji oraz żądanie subskrypcji, odpowiednio oznaczone
Protokół serwera	Typ powstającego żądania (zob. poniżej)
Schemat wiadomości	Przykładowy ładunek zbudowany według schematu
Opisy	Dokumentacja API

Żądania są grupowane w jednym folderze na każdy protokół.

Odwzorowanie protokołów

Protokół AsyncAPI	Powstające żądanie Restorm
mqtt, mqtts	MQTT, z prefiksem adresu URL mqtt://
socketio, socket.io	Socket.IO
Wszystko pozostałe	WebSocket, z prefiksem adresu URL ws://

Kafka i AMQP

Powiązania AsyncAPI dla Kafki i AMQP nie tworzą żądań Kafka ani AMQP: wpadają do kategorii „wszystko pozostałe” i dają żądania WebSocket. Takie żądania trzeba utworzyć ręcznie po imporcie — zaimportowana struktura kanałów dostarcza tematów i kolejek, które można przenieść.

Aktualizacja

AsyncAPI należy do formatów, które można ponownie zsynchronizować. Zob. Aktualizacja ze źródła.