Importar um documento AsyncAPI
O AsyncAPI descreve as API orientadas por eventos como o OpenAPI descreve as API REST. O Restorm extrai dele pedidos de mensagens.
Importar
Section titled “Importar”Ficheiro ▸ Importar (Ctrl+I) e depois o documento, em YAML ou em
JSON.
O que é importado
Section titled “O que é importado”| Elemento | O que o Restorm faz com ele |
|---|---|
| Cada canal | Um pedido de publicação e um pedido de subscrição, identificados como tal |
| O protocolo do servidor | O tipo do pedido produzido (ver abaixo) |
| O esquema das mensagens | Um payload de exemplo construído a partir do esquema |
| Descrições | A documentação de API |
Os pedidos são agrupados numa pasta por protocolo.
Correspondência dos protocolos
Section titled “Correspondência dos protocolos”| Protocolo AsyncAPI | Pedido Restorm produzido |
|---|---|
mqtt, mqtts | MQTT, com um prefixo de URL mqtt:// |
socketio, socket.io | Socket.IO |
| Todo o resto | WebSocket, com um prefixo de URL ws:// |
Atualizar
Section titled “Atualizar”O AsyncAPI faz parte dos formatos ressincronizáveis. Consulte Atualizar a partir da origem.