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.
Utilisation des intégrations de AWS Lambda proxy pour les API HTTP
Une intégration de proxy Lambda vous permet d'intégrer un itinéraire API à une fonction Lambda. Lorsqu'un client appelle votre API, API Gateway envoie la demande à la fonction Lambda et renvoie la réponse de la fonction au client. Pour obtenir des exemples de création d'une API HTTP, veuillez consulter Création d'une API HTTP.
Version du format de charge utile
La version du format de charge utile spécifie le format de l'événement qu'API Gateway envoie à une intégration Lambda, ainsi que la manière dont API Gateway interprète la réponse de Lambda. Si vous ne spécifiez pas de version de format de charge utile, la dernière version est AWS Management Console utilisée par défaut. Si vous créez une intégration Lambda à l'aide du AWS CLI AWS CloudFormation, ou d'un SDK, vous devez spécifier un. payloadFormatVersion
Les valeurs prises en charge sont 1.0
et 2.0
.
Pour plus d'informations sur la façon de définir lepayloadFormatVersion
, consultez la section create-integration. Pour plus d'informations sur la façon de déterminer la valeur payloadFormatVersion
d'une intégration existante, consultez get-integration
Différences de format de charge utile
La liste suivante indique les différences entre les versions du format 1.0
et du format 2.0
de charge utile :
Le format
2.0
n'a pas de champsmultiValueHeaders
oumultiValueQueryStringParameters
. Les en-têtes dupliqués sont combinés avec des virgules et inclus dans le champheaders
. Les chaînes de requête en double sont combinées avec des virgules et incluses dans le champqueryStringParameters
.-
Le format
2.0
rawPath
a. Si vous utilisez un mappage d'API pour connecter votre stage à un nom de domaine personnalisé, vousrawPath
ne fournirez pas la valeur de mappage d'API. Utilisez le format1.0
et accédezpath
au mappage d'API pour votre nom de domaine personnalisé. Le format
2.0
inclut un nouveau champcookies
. Tous les en-têtes de cookie dans la demande sont combinés avec des virgules et ajoutés au champcookies
. Dans la réponse au client, chaque cookie devient un en-têteset-cookie
.
Structure du format de charge utile
Les exemples suivants montrent la structure de chaque version de format de charge utile. Tous les noms d'en-tête sont en minuscules.
Format de réponse de fonction Lambda
La version du format de charge utile détermine la structure de la réponse que votre fonction Lambda doit renvoyer.
Réponse de la fonction Lambda pour le format 1.0
Avec la version 1.0
au format, les intégrations Lambda doivent renvoyer une réponse au format JSON suivant :
{ "isBase64Encoded": true|false, "statusCode": httpStatusCode, "headers": { "headername": "headervalue", ... }, "multiValueHeaders": { "headername": ["headervalue", "headervalue2", ...], ... }, "body": "..." }
Réponse de la fonction Lambda pour le format 2.0
Avec la version de format 2.0
, API Gateway peut déduire le format de réponse pour vous. API Gateway fait les hypothèses suivantes si votre fonction Lambda renvoie JSON valide et ne renvoie pas un statusCode
:
-
isBase64Encoded
estfalse
. -
statusCode
est200
. -
content-type
estapplication/json
. -
body
est la réponse de la fonction.
Les exemples suivants montrent la sortie d'une fonction Lambda et l'interprétation d'API Gateway.
Sortie de la fonction Lambda | Interprétation d'API Gateway |
---|---|
|
|
|
|
Pour personnaliser la réponse, votre fonction Lambda doit renvoyer une réponse au format suivant.
{ "cookies" : ["
cookie1
", "cookie2
"], "isBase64Encoded": true|false, "statusCode":httpStatusCode
, "headers": { "headername
": "headervalue
", ... }, "body": "Hello from Lambda!
" }