Configuration des réponses d'itinéraire pour les WebSocket API dans API Gateway

WebSocket les itinéraires peuvent être configurés pour une communication bidirectionnelle ou unidirectionnelle. API Gateway ne transmet pas la réponse du backend à la réponse de routage, sauf si vous avez configuré une réponse de routage.

Note

Vous pouvez uniquement définir la réponse de l'$defaultitinéraire pour les WebSocket API. Vous pouvez utiliser une réponse d'intégration pour manipuler la réponse d'un service backend. Pour plus d’informations, consultez Présentation des réponses d'intégration.

Vous pouvez configurer les réponses d'itinéraire et les expressions de sélection des réponses à l'aide de la console API Gateway AWS CLI ou d'un AWS SDK.

Pour plus d'informations sur les expressions de sélection de la réponse de routage, consultez la section Expressions de sélection de la réponse de routage.

Configuration d'une réponse de routage à l'aide de la console API Gateway

Après avoir créé une WebSocket API et attaché une fonction Lambda proxy à la route par défaut, vous pouvez configurer la réponse de route à l'aide de la console API Gateway :

1. Connectez-vous à la console API Gateway, choisissez une WebSocket API avec une intégration de la fonction Lambda par proxy sur la $default route.

2. Sous Routes (Routes), choisissez la route $default.

3. Choisissez Activer la communication bidirectionnelle.

4. Sélectionnez Deploy API (Déployer une API).

5. Déployez votre API vers une étape.

Utilisez la commande wscat suivante pour vous connecter à votre API. Pour plus d’informations sur wscat, consultez wscatÀ utiliser pour se connecter à une WebSocket API et y envoyer des messages.

wscat -c wss://api-id.execute-api.us-east-2.amazonaws.com/test

Appuyez sur la touche Entrée pour appeler la route par défaut. Le corps de votre fonction Lambda vous est renvoyé.

Configurez une réponse d'itinéraire à l'aide du AWS CLI

Pour configurer une réponse de route pour une WebSocket API à l'aide de AWS CLI, appelez la create-route-responsecommande comme indiqué dans l'exemple suivant. Vous pouvez identifier l'ID d'API et l'ID de routage en appelant get-apis et get-routes.

aws apigatewayv2 create-route-response \
    --api-id aabbccddee \
    --route-id 1122334  \
    --route-response-key '$default'

Exemple de sortie :

{
    "RouteResponseId": "abcdef",
    "RouteResponseKey": "$default"
}