Activation de la prise en charge binaire à l'aide de la console API Gateway

Cette section explique comment activer la prise en charge binaire à l'aide de la console API Gateway. À titre d'exemple, nous utilisons une API intégrée à Amazon S3. Nous nous concentrons sur les tâches visant à définir les types de supports pris en charge afin de spécifier la façon dont la charge utile doit être gérée. Pour obtenir des informations détaillées sur la création d'une API intégrée à Amazon S3, veuillez consulter Tutoriel : Création d'une API REST en tant que proxy Amazon S3.

Pour activer la prise en charge binaire à l'aide de la console API Gateway

1. Définissez les types de supports binaires pour l'API :

   1. Créez une API ou choisissez une API existante. Pour cet exemple, nous appelons l'API FileMan.

   2. Sous l’API sélectionnée dans le panneau de navigation principal, choisissez Paramètres de l’API.

   3. Dans le volet Paramètres de l’API, choisissez Gérer les types de médias dans la section Types de médias binaires.

   4. Choisissez Ajouter un type de médias binaires.

   5. Saisissez un type de média requis, par exemple image/png, dans le champ de texte d’entrée. Si nécessaire, répétez cette étape pour ajouter d'autres types de médias. Pour prendre en charge tous les types de supports binaires, spécifiez */*.

   6. Sélectionnez Enregistrer les modifications.

2. Définissez la façon dont les charges utiles du message sont traitées pour la méthode de l'API :

   1. Créez une nouvelle ressource ou choisissez-en une existante dans l'API. Dans le cadre de cet exemple, nous utilisons la ressource /{folder}/{item}.

   2. Créez une méthode ou choisissez-en une existante sur la ressource. À titre d'exemple, nous utilisons la méthode GET /{folder}/{item} intégrée à l'action Object GET dans Amazon S3.

   3. Dans Gestion de contenu, choisissez une option.

      

      Choisissez Passthrough si vous ne souhaitez pas convertir le corps lorsque le client et le backend acceptent le même format binaire. Choisissez Convertir en texte pour convertir le corps binaire en chaîne encodée en base64 lorsque, par exemple, le backend a besoin qu’une charge utile de requête binaire soit passée en tant que propriété JSON. Choisissez Convertir en binaire lorsque le client envoie une chaîne encodée en base64 et si le backend nécessite le format binaire d’origine, ou lorsque le point de terminaison retourne une chaîne encodée en base64 et si le client accepte uniquement la sortie binaire.

   4. Pour Transmission du corps de requête, choisissez Lorsqu’aucun modèle n’est défini (recommandé) pour activer le comportement de transmission pour le corps de la requête.

      Vous pouvez également choisir Jamais. Cela signifie que l’API rejettera les données avec des types de contenu qui ne disposent pas d’un modèle de mappage.

   5. Conservez l'en-tête Accept de la demande entrante dans la demande d'intégration. Procédez ainsi si vous avez défini contentHandling sur passthrough et que vous souhaitez remplacer ce paramètre au moment de l'exécution.

      

   6. Pour la conversion en texte, définissez un modèle de mappage afin de convertir les données binaires encodées en base64 au format requis.

      Voici un exemple de modèle de mappage à convertir en texte :

      {
        "operation": "thumbnail",
        "base64Image": "$input.body"
      }

      Le format de ce modèle de mappage s'appuie sur les exigences de point de terminaison de l'entrée.

   7. Choisissez Enregistrer.