Mengimpor dokumen AsyncAPI
AsyncAPI menggambarkan API yang digerakkan peristiwa sebagaimana OpenAPI menggambarkan API REST. Restorm menyarikannya menjadi permintaan perpesanan.
Mengimpor
Section titled “Mengimpor”File ▸ Impor (Ctrl+I) lalu pilih dokumennya, dalam YAML atau JSON.
Apa yang diimpor
Section titled “Apa yang diimpor”| Elemen | Yang dibuat Restorm darinya |
|---|---|
| Setiap kanal | Sebuah permintaan publikasi dan sebuah permintaan langganan, yang diberi label sesuai perannya |
| Protokol servernya | Tipe permintaan yang dihasilkan (lihat di bawah) |
| Skema pesannya | Sebuah muatan contoh yang disusun menurut skemanya |
| Deskripsi | Dokumentasi API |
Permintaannya dikelompokkan ke dalam satu folder per protokol.
Pemetaan protokol
Section titled “Pemetaan protokol”| Protokol AsyncAPI | Permintaan Restorm yang dihasilkan |
|---|---|
mqtt, mqtts | MQTT, dengan awalan URL mqtt:// |
socketio, socket.io | Socket.IO |
| Selebihnya | WebSocket, dengan awalan URL ws:// |
Memperbarui
Section titled “Memperbarui”AsyncAPI termasuk format yang dapat disinkronkan ulang. Lihat Memperbarui dari sumber.