Configurer une réponse de passerelle pour une API REST à l’aide de la console API Gateway

Pour personnaliser une réponse de passerelle à l’aide de la console API Gateway

1. Connectez-vous à la console API Gateway à l’adresse https://console.aws.amazon.com/apigateway.

2. Choisissez une API REST.

3. Dans le panneau de navigation principal, choisissez Réponses de la passerelle.

4. Choisissez un type de réponse, puis choisissez Modifier. Dans cette procédure, nous allons utiliser Jeton d’authentification manquant comme exemple.

5. Vous pouvez modifier le Code de statut généré par API Gateway pour renvoyer un autre code de statut qui répond aux exigences de votre API. Dans cet exemple, la personnalisation modifie le code de statut de la valeur par défaut (403) à 404, car ce message d’erreur est émis lorsqu’un client appelle une ressource non prise en charge ou non valide qui peut être considérée comme non trouvée.

6. Pour renvoyer des en-têtes personnalisés, choisissez Ajouter un en-tête de réponse sous En-têtes de réponse. À titre d’illustration, nous allons ajouter les en-têtes personnalisés suivants :

   Access-Control-Allow-Origin:'a.b.c'
   x-request-id:method.request.header.x-amzn-RequestId
   x-request-path:method.request.path.petId
   x-request-query:method.request.querystring.q
   

   Dans les mappages d’en-tête précédents, un nom de domaine statique ('a.b.c') est mappé à l’en-tête Allow-Control-Allow-Origin pour autoriser l’accès CORS à l’API, l’en-tête de demande d’entrée de x-amzn-RequestId est mappé à request-id dans la réponse, la variable de chemin petId de la demande entrante est mappée à l’en-tête request-path dans la réponse et le paramètre de requête q de la demande d’origine est mappé à l’en-tête request-query de la réponse.

7. Sous Modèles de réponse, conservez application/json pour le Type de contenu et saisissez le modèle de mappage de corps suivant dans l’éditeur Modèle de mappage de corps :

   {
        "message":"$context.error.messageString",
        "type": "$context.error.responseType",
        "statusCode": "'404'",
        "stage": "$context.stage",
        "resourcePath": "$context.resourcePath",
        "stageVariables.a": "$stageVariables.a"
   }

   Cet exemple montre comment mapper les propriétés $context et $stageVariables aux propriétés du corps de demande de passerelle.

8. Sélectionnez Enregistrer les modifications.

9. Déployez l’API dans une étape nouvelle ou existante.