AsyncAPI-dokumentin tuonti
AsyncAPI kuvaa tapahtumapohjaisia API:ita samoin kuin OpenAPI kuvaa REST-API:ita. Restorm muodostaa siitä viestintäpyyntöjä.
Tuonti
Section titled “Tuonti”Tiedosto ▸ Tuo (Ctrl+I) ja sitten dokumentti YAML- tai
JSON-muodossa.
Mitä tuodaan
Section titled “Mitä tuodaan”| Elementti | Mitä Restorm tekee siitä |
|---|---|
| Jokainen kanava | Yksi julkaisupyyntö ja yksi tilauspyyntö, kumpikin merkittynä sellaiseksi |
| Palvelimen protokolla | Tuotetun pyynnön tyyppi (katso alta) |
| Viestien skeema | Skeeman perusteella rakennettu esimerkkihyötykuorma |
| Kuvaukset | API-dokumentaatio |
Pyynnöt ryhmitellään yhteen kansioon protokollaa kohti.
Protokollien vastaavuus
Section titled “Protokollien vastaavuus”| AsyncAPI-protokolla | Tuotettu Restorm-pyyntö |
|---|---|
mqtt, mqtts | MQTT, URL-etuliitteellä mqtt:// |
socketio, socket.io | Socket.IO |
| Kaikki muut | WebSocket, URL-etuliitteellä ws:// |
Päivittäminen
Section titled “Päivittäminen”AsyncAPI kuuluu uudelleen synkronoitaviin muotoihin. Katso Päivitys lähteestä.