Ein AsyncAPI-Dokument importieren
AsyncAPI beschreibt ereignisgesteuerte APIs so, wie OpenAPI REST-APIs beschreibt. Restorm erstellt daraus Messaging-Anfragen.
Importieren
Section titled “Importieren”Datei ▸ Importieren (Ctrl+I), dann das Dokument, in YAML oder in
JSON.
Was importiert wird
Section titled “Was importiert wird”| Element | Was Restorm daraus macht |
|---|---|
| Jeder Kanal | Eine Publish-Anfrage und eine Subscribe-Anfrage, entsprechend beschriftet |
| Das Server-Protokoll | Der Typ der erzeugten Anfrage (siehe unten) |
| Das Nachrichtenschema | Eine anhand des Schemas erstellte Beispiel-Payload |
| Beschreibungen | Die API-Dokumentation |
Die Anfragen werden in einem Ordner pro Protokoll gruppiert.
Protokollzuordnung
Section titled “Protokollzuordnung”| AsyncAPI-Protokoll | Erzeugte Restorm-Anfrage |
|---|---|
mqtt, mqtts | MQTT, mit einem URL-Präfix mqtt:// |
socketio, socket.io | Socket.IO |
| Alles Übrige | WebSocket, mit einem URL-Präfix ws:// |
Aktualisieren
Section titled “Aktualisieren”AsyncAPI gehört zu den re-synchronisierbaren Formaten. Siehe Aktualisierung aus der Quelle.