AsyncAPI dokumentum importálása
Az AsyncAPI úgy írja le az esemény alapú API-kat, ahogyan az OpenAPI a REST API-kat. A Restorm üzenetküldő kéréseket készít belőle.
Importálás
Section titled “Importálás”Fájl ▸ Importálás (Ctrl+I), majd a dokumentum, YAML vagy JSON
formában.
Az importált elemek
Section titled “Az importált elemek”| Elem | Amit a Restorm készít belőle |
|---|---|
| Minden csatorna | Egy publikálási és egy feliratkozási kérés, ennek megfelelő címkével |
| A kiszolgáló protokollja | Az előállított kérés típusa (lásd alább) |
| Az üzenetek sémája | A séma alapján felépített példa payload |
| Leírások | Az API-dokumentáció |
A kérések protokollonként egy-egy mappába kerülnek.
A protokollok megfeleltetése
Section titled “A protokollok megfeleltetése”| AsyncAPI-protokoll | Az előállított Restorm-kérés |
|---|---|
mqtt, mqtts | MQTT, mqtt:// URL-előtaggal |
socketio, socket.io | Socket.IO |
| Minden egyéb | WebSocket, ws:// URL-előtaggal |
Frissítés
Section titled “Frissítés”Az AsyncAPI az újraszinkronizálható formátumok közé tartozik. Lásd: Frissítés a forrásból.