AsyncAPI ドキュメントをインポートする
AsyncAPI は、OpenAPI が REST API を記述するのと同じように、イベント駆動型の API を記述します。 Restorm はそこからメッセージング用のリクエストを生成します。
ファイル ▸ インポート(Ctrl+I)から、YAML または JSON のドキュメントを選択します。
インポートされる内容
Section titled “インポートされる内容”| 要素 | Restorm での扱い |
|---|---|
| 各チャネル | 発行用のリクエストと購読用のリクエストが 1 つずつ、それぞれその旨のラベル付きで作成されます |
| サーバーのプロトコル | 生成されるリクエストの種類(下記参照) |
| メッセージのスキーマ | スキーマから組み立てられたサンプルペイロード |
| 説明 | API ドキュメント |
リクエストはプロトコルごとのフォルダーにまとめられます。
プロトコルの対応関係
Section titled “プロトコルの対応関係”| AsyncAPI のプロトコル | 生成される Restorm のリクエスト |
|---|---|
mqtt、mqtts | MQTT(URL に mqtt:// の接頭辞が付きます) |
socketio、socket.io | Socket.IO |
| その他すべて | WebSocket(URL に ws:// の接頭辞が付きます) |
AsyncAPI は再同期に対応した形式のひとつです。ソースから更新するを参照してください。