Sobre as WebSocket APIs no API Gateway

No API Gateway, você pode criar uma WebSocket API como front-end com estado para um AWS serviço (como Lambda ou DynamoDB) ou para um endpoint HTTP. A WebSocket API invoca seu back-end com base no conteúdo das mensagens que recebe dos aplicativos clientes.

Ao contrário de uma API REST, que recebe e responde às solicitações, uma WebSocket API oferece suporte à comunicação bidirecional entre aplicativos clientes e seu back-end. O backend pode enviar mensagens de retorno para clientes conectados.

Na sua WebSocket API, as mensagens JSON recebidas são direcionadas para integrações de back-end com base nas rotas que você configura. (Mensagens que não apresentam o formato JSON são direcionadas para a rota $default que você configurar).

Uma rota inclui uma chave de roteamento, que é o valor esperado quando uma expressão de seleção de rotas é avaliada. O routeSelectionExpression é um atributo definido em nível de API. Ele especifica uma propriedade JSON que deve estar presente na carga da mensagem. Para obter mais informações sobre expressões de seleção de rota, consulte Expressões de seleção de rota.

Por exemplo, se as suas mensagens JSON contêm uma propriedade action e você deseja realizar ações diferentes de acordo com essa propriedade, sua expressão de seleção de rotas pode ser ${request.body.action}. A tabela de roteamento deve especificar qual ação executar ao corresponder o valor da propriedade action com os valores de chave de rotas personalizada que você definiu na tabela.

Há três rotas predefinidas que podem ser usadas: $connect, $disconnect e $default. Além disso, você pode criar rotas personalizadas.

• O API Gateway chama a $connect rota quando uma conexão persistente entre o cliente e uma WebSocket API está sendo iniciada.

• O API Gateway chama a rota $disconnect quando o cliente ou o servidor é desconectado da API.

• O API Gateway chama uma rota personalizada após a avaliação da expressão de seleção de rotas personalizada em relação à mensagem caso uma rota correspondente seja encontrada; a correspondência determina qual integração é invocada.

• O API Gateway chamará a rota $default se a expressão de seleção de rotas não puder ser avaliada em relação à mensagem ou se nenhuma rota correspondente for encontrada.

Para obter mais informações sobre as rotas $connect e $disconnect, consulte Gerenciar usuários conectados e aplicativos do cliente: rotas $connect e $disconnect.

Para obter mais informações sobre a rota $default e rotas personalizadas, consulte Invocar a integração de seu backend: rota $default e rotas personalizadas.

Os serviços de backend podem enviar dados para aplicativos conectados do cliente. Para obter mais informações, consulte Enviar dados dos serviços de backend para clientes conectados.