导入 AsyncAPI 文档
AsyncAPI 描述事件驱动的 API,就像 OpenAPI 描述 REST API 一样。Restorm 会从中 生成消息类请求。
文件 ▸ 导入(Ctrl+I),然后选择该文档,YAML 或 JSON 均可。
| 元素 | Restorm 如何处理 |
|---|---|
| 每个通道 | 一个发布请求和一个订阅请求,并作相应标注 |
| 服务器的协议 | 所生成请求的类型(见下文) |
| 消息的模式 | 按该模式构建的示例负载 |
| 描述 | API 文档 |
这些请求会按协议分组放入文件夹。
协议对应关系
Section titled “协议对应关系”| AsyncAPI 协议 | 生成的 Restorm 请求 |
|---|---|
mqtt、mqtts | MQTT,URL 前缀为 mqtt:// |
socketio、socket.io | Socket.IO |
| 其余全部 | WebSocket,URL 前缀为 ws:// |
AsyncAPI 属于可重新同步的格式。参见 从源更新。