Importera ett AsyncAPI-dokument
AsyncAPI beskriver händelsestyrda API:er på samma sätt som OpenAPI beskriver REST-API:er. Restorm gör meddelandebegäranden av det.
Importera
Section titled “Importera”Arkiv ▸ Importera (Ctrl+I) och sedan dokumentet, i YAML eller JSON.
Vad som importeras
Section titled “Vad som importeras”| Element | Vad Restorm gör av det |
|---|---|
| Varje kanal | En publiceringsbegäran och en prenumerationsbegäran, märkta som sådana |
| Serverns protokoll | Typen på den begäran som skapas (se nedan) |
| Meddelandenas schema | En exempelpayload byggd utifrån schemat |
| Beskrivningar | API-dokumentationen |
Begärandena grupperas i en mapp per protokoll.
Protokollmappning
Section titled “Protokollmappning”| AsyncAPI-protokoll | Begäran som Restorm skapar |
|---|---|
mqtt, mqtts | MQTT, med URL-prefixet mqtt:// |
socketio, socket.io | Socket.IO |
| Allt annat | WebSocket, med URL-prefixet ws:// |
Uppdatera
Section titled “Uppdatera”AsyncAPI är ett av de format som går att synkronisera om. Se Uppdatera från källan.