x-amazon-apigateway-integrationObjet .RequestParameters - 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.

x-amazon-apigateway-integrationObjet .RequestParameters

Pour les API REST, spécifie les mappages des paramètres de demande de méthode nommés aux paramètres de demande d'intégration. Les paramètres de demande de méthode doivent être définis avant d'être référencés.

Pour les API HTTP, spécifie les paramètres qui sont transmis aux intégrations AWS_PROXY avec un paramètre integrationSubtype spécifié.

Propriétés
Nom de la propriété Type Description
integration.request.<param-type>.<param-name> string

Pour les API REST, la valeur est généralement un paramètre de demande de méthode prédéfini au format method.request.<param-type>.<param-name>, où <param-type> peut avoir la valeur querystring, path, header ou body. Toutefois, $context.VARIABLE_NAME, $stageVariables.VARIABLE_NAME et STATIC_VALUE sont également valides. Pour le paramètre body, la valeur <param-name> est une expression de chemin JSON sans le préfixe $..

parameter string

Pour les API HTTP, les paramètres de demande sont une carte clé-valeur spécifiant les paramètres qui sont transmis aux intégrations AWS_PROXY avec un paramètre spécifié integrationSubtype. Vous pouvez fournir des valeurs statiques ou des données de demande de carte, des variables intermédiaires ou des variables de contexte évaluées au moment de l'exécution. Pour en savoir plus, consultez la section Utilisation des intégrations de services AWS pour les API HTTP.

x-amazon-apigateway-integration.requestParametersExemple

L'exemple de mappage de paramètres de demande suivant convertit respectivement les paramètres de requête (version), d'en-tête (x-user-id) et de chemin (service) d'une demande de méthode en paramètres de requête (stage), d'en-tête (x-userid) et de chemin (op) de la demande d'intégration.

Note

Si vous créez des ressources via OpenAPI AWS CloudFormation, les valeurs statiques doivent être placées entre guillemets simples.

Pour ajouter cette valeur à partir de la console, saisissez application/json dans la zone, sans guillemets.

"requestParameters" : { "integration.request.querystring.stage" : "method.request.querystring.version", "integration.request.header.x-userid" : "method.request.header.x-user-id", "integration.request.path.op" : "method.request.path.service" },