Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Créer des itinéraires pour WebSocket APIs dans API Gateway

Dans votre WebSocket API, les JSON messages entrants sont dirigés vers des intégrations de backend en fonction des itinéraires que vous configurez. (Les JSON messages non électroniques sont dirigés vers un $default itinéraire que vous configurez.)

Une route comprend une clé de routage, qui correspond à la valeur attendue une fois qu'une expression de sélection de la route est évaluée. routeSelectionExpressionIl s'agit d'un attribut défini au API niveau. Il spécifie une JSON propriété qui devrait être présente dans la charge utile du message. Pour plus d'informations sur les expressions de sélection de la route, consultez la section Expressions de sélection de la route.

Par exemple, si vos JSON messages contiennent une action propriété et que vous souhaitez effectuer différentes actions en fonction de cette propriété, votre expression de sélection d'itinéraire peut être${request.body.action}. Votre table de routage spécifie l'action à exécuter en mettant en correspondance la valeur de la propriété action avec les valeurs des clés de routage personnalisées que vous avez définies dans la table.

Trois routes prédéfinies peuvent être utilisées : $connect, $disconnect et $default. De plus, vous pouvez créer des routes personnalisées.

Expressions de sélection de la route

Une expression de sélection de la route est évaluée lorsque le service sélectionne la route que doit suivre un message entrant. Le service utilise la route dont la clé routeKey correspond exactement à la valeur évaluée. Si aucune clé ne correspond et qu'une route avec la clé $default existe, celle-ci est sélectionnée. Si aucune route ne correspond à la valeur évaluée et qu'il n'y a pas de route $default, le service renvoie une erreur. Pour WebSocket basedAPIs, l'expression doit être de la forme$request.body.{path_to_body_element}.

Supposons, par exemple, que vous envoyiez le JSON message suivant :

{
    "service" : "chat",
    "action" : "join",
    "data" : {
        "room" : "room1234"
   }
}

Vous souhaiterez peut-être sélectionner votre API comportement en fonction de la action propriété. Dans ce cas, vous pouvez définir l'expression de sélection de la route suivante :

$request.body.action

Dans cet exemple, il request.body fait référence à la JSON charge utile de votre message et .action est une JSONPathexpression. Vous pouvez utiliser n'importe quelle expression de JSON chemin par la suiterequest.body, mais gardez à l'esprit que le résultat sera stringifié. Par exemple, si votre JSONPath expression renvoie un tableau de deux éléments, celui-ci sera présenté sous forme de chaîne"[item1, item2]". C'est la raison pour laquelle il est recommandé d'utiliser une expression qui correspond à une valeur plutôt qu'à un tableau ou un objet.

Vous pouvez utiliser simplement une valeur statique ou plusieurs variables. Le tableau suivant montre des exemples et leurs résultats évalués par rapport à la charge utile précédente.

Le résultat évalué est utilisé pour trouver une route. S'il existe une route avec une clé de routage correspondante, elle est sélectionnée pour traiter le message. Si aucun itinéraire correspondant n'est trouvé, API Gateway essaie de le $default trouver s'il est disponible. Si l'$defaultitinéraire n'est pas défini, API Gateway renvoie une erreur.

Configurer des itinéraires pour une WebSocket API API passerelle intégrée

Lorsque vous en créez un nouveau pour la première fois WebSocket API, il existe trois itinéraires prédéfinis : $connect$disconnect, et$default. Vous pouvez les créer à l'aide de la consoleAPI, ou AWS CLI. Si vous le souhaitez, vous pouvez créer des routes personnalisées. Pour plus d’informations, consultez Présentation de WebSocket APIs in API Gateway.

Création d'un itinéraire à l'aide de la console API Gateway

Créez un itinéraire à l'aide du AWS CLI

Pour créer un itinéraire à l'aide du AWS CLI, appelez create-routecomme indiqué dans l'exemple suivant :

aws apigatewayv2 --region us-east-1 create-route --api-id aabbccddee --route-key $default

Exemple de sortie :

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "$default",
    "RouteId": "1122334"
}

Spécification des paramètres de la demande de route pour $connect

Lorsque vous configurez l'$connectitinéraire pour votreAPI, les paramètres facultatifs suivants sont disponibles pour activer l'autorisation pour votreAPI. Pour plus d’informations, consultez Route $connect.

Configuration de la demande d'$connectitinéraire à l'aide de la console API Gateway

Pour configurer la demande d'$connectitinéraire pour un à WebSocket API l'aide de la console API Gateway :