Sélectionner vos préférences de cookies

Nous utilisons des cookies essentiels et des outils similaires qui sont nécessaires au fonctionnement de notre site et à la fourniture de nos services. Nous utilisons des cookies de performance pour collecter des statistiques anonymes afin de comprendre comment les clients utilisent notre site et d’apporter des améliorations. Les cookies essentiels ne peuvent pas être désactivés, mais vous pouvez cliquer sur « Personnaliser » ou « Refuser » pour refuser les cookies de performance.

Si vous êtes d’accord, AWS et les tiers approuvés utiliseront également des cookies pour fournir des fonctionnalités utiles au site, mémoriser vos préférences et afficher du contenu pertinent, y compris des publicités pertinentes. Pour accepter ou refuser tous les cookies non essentiels, cliquez sur « Accepter » ou « Refuser ». Pour effectuer des choix plus détaillés, cliquez sur « Personnaliser ».

Configurer le mappage des données pour WebSocket APIs dans API Gateway

Mode de mise au point
Configurer le mappage des données pour WebSocket APIs dans API Gateway - Amazon API Gateway

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.

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.

Le mappage de données vous permet de mapper des données d’une demande de routage vers une intégration backend.

Note

Le mappage de données pour WebSocket APIs n'est pas pris en charge dans le AWS Management Console. Vous devez utiliser le AWS CLI AWS CloudFormation, ou un SDK pour configurer le mappage des données.

Mappage des données de demande de routage à des paramètres de demande d’intégration

Les paramètres de demande d’intégration peuvent être mappés à partir de n’importe quels paramètres de demande de routage défini, du corps de la demande, des variables context ou stage, ainsi que des valeurs statiques.

Le tableau suivant présente les expressions de mappage des données des demandes d’intégration. Dans le tableau, PARAM_NAME est le nom d’un paramètre de demande de routage du type de paramètre donné. Elle doit correspondre à l'expression régulière'^[a-zA-Z0-9._$-]+$]'. JSONPath_EXPRESSIONest une JSONPath expression pour un champ JSON du corps de la requête.

Source de données mappée Expression de mappage
Chaîne de requête de demande (prise en charge uniquement pour le routage $connect) route.request.querystring.PARAM_NAME
En-tête de demande (prise en charge uniquement pour le routage $connect) route.request.header.PARAM_NAME
Chaîne de demande à plusieurs valeurs (prise en charge uniquement pour le routage $connect) route.request.multivaluequerystring.PARAM_NAME
En-tête de demande à plusieurs valeurs (prise en charge uniquement pour le routage $connect) route.request.multivalueheader.PARAM_NAME
Corps de la demande route.request.body.JSONPath_EXPRESSION
Variables d’étape stageVariables.VARIABLE_NAME
Variables de contexte context.VARIABLE_NAME qui doit être l’une des variables de contexte prises en charge.
Valeur statique 'STATIC_VALUE'. STATIC_VALUEIl s'agit d'une chaîne littérale qui doit être placée entre guillemets simples.

Exemples

Les AWS CLI exemples suivants configurent les mappages de données. Pour un exemple AWS CloudFormation de modèle, voir websocket-data-mapping.yaml.

Mapper ConnectionID d’un client à un en-tête dans une demande d’intégration

La commande de mise à jour suivante fait correspondre le nom d'un client connectionId à un connectionId en-tête de la demande d'intégration principale :

aws apigatewayv2 update-integration \ --integration-id abc123 \ --api-id a1b2c3d4 \ --request-parameters 'integration.request.header.connectionId'='context.connectionId'

Mapper un paramètre de chaîne de demande à un en-tête dans une demande d’intégration

L'exemple suivant fait correspondre un paramètre de chaîne de authToken requête à un authToken en-tête de la demande d'intégration.

  1. Utilisez la commande update-route suivante pour ajouter le paramètre de chaîne de authToken requête aux paramètres de demande de la route.

    aws apigatewayv2 update-route --route-id 0abcdef \ --api-id a1b2c3d4 \ --request-parameters '{"route.request.querystring.authToken": {"Required": false}}'
  2. Utilisez la commande update-integration suivante pour mapper le paramètre de chaîne de requête à l'authTokenen-tête de la demande d'intégration du backend.

    aws apigatewayv2 update-integration \ --integration-id abc123 \ --api-id a1b2c3d4 \ --request-parameters 'integration.request.header.authToken'='route.request.querystring.authToken'
  3. (Facultatif) Si nécessaire, utilisez ce qui suit delete-route-request-parameterpour supprimer le paramètre de chaîne de authToken requête des paramètres de demande de l'itinéraire.

    aws apigatewayv2 delete-route-request-parameter \ --route-id 0abcdef \ --api-id a1b2c3d4 \ --request-parameter-key 'route.request.querystring.authToken'
ConfidentialitéConditions d'utilisation du sitePréférences de cookies
© 2025, Amazon Web Services, Inc. ou ses affiliés. Tous droits réservés.