Utilisation de l'API Gateway à l'aide de la boîte à outils AWS - AWS Cloud9

AWS Cloud9 n'est plus disponible pour les nouveaux clients. Les clients existants de AWS Cloud9 peuvent continuer à utiliser le service normalement. En savoir plus »

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 de l'API Gateway à l'aide de la boîte à outils AWS

Vous pouvez utiliser API Gateway pour créer des API RESTful et des API WebSocket qui permettent mettent en œuvre des applications de communication bidirectionnelle en temps réel. Pour obtenir plus d'informations sur la création et la gestion des API avec API Gateway, consultez le Guide du développeur API Gateway.

Avec la boîte à outils AWS, vous pouvez configurer un appel à une API REST en spécifiant la ressource REST, le type de méthode et les données transmises en entrée.

Appel d'API REST dans API Gateway

Important

L’appel de méthodes d’API à l'aide d'AWS Toolkit peut entraîner des modifications qui ne peuvent pas être modifiées. Par exemple, si vous appelez une méthode POST, les ressources de l'API sont mises à jour si l'appel réussit.

Vous pouvez appeler une API Gateway sur AWS à partir de la boîte à outils AWS.

Pour appeler une API REST

  1. Dans Explorer AWS, choisissez le nœud API Gateway pour afficher la liste des API REST disponibles dans la Région AWS actuelle.

  2. Cliquez avec le bouton droit sur une API REST, puis choisissez Appeler surAWS.

    Note

    Vous pouvez utiliser le menu contextuel pour copier l'URL, le nom et l’Amazon Resource Name (ARN) de l'API REST.

    La fenêtre Invoke methods (Appeler des méthodes) s'affiche. Vous pouvez configurer l'appel à l'API.

  3. Pour Select a resource (Sélectionner une ressource), choisissez la ressource REST avec laquelle vous souhaitez interagir.

  4. Pour Sélectionner une méthode, choisissez l'un des types de méthodes suivants :

    • GET : obtient une ressource du service backend accessible via l'API.

    • OPTIONS : demande des informations sur les méthodes et les opérations prises en charge par API Gateway.

    • POST : crée une ressource sur le service backend accessible via l’l'API.

  5. Pour fournir une entrée à votre appel de méthode d’API, vous pouvez utiliser une chaîne de requête ou une charge utile au format JSON :

    • Chaîne de requête : entrez une chaîne de requête en utilisant le format parameter1=value1&parameter2=value2. (Avant d'utiliser des chaînes de requête, créez un modèle de mappagepour transformer les demandes web entrantes avant qu'elles soient envoyées au backend d'intégration.)

    • Format JSON : vous pouvez définir une charge utile au format JSON dans le grand champ de texte dans la fenêtre Appeler des méthodes.

      Par exemple, vous pouvez ajouter une nouvelle ressource avec une méthode POST qui contient la charge utile suivante :

      {"type": "soda", "price" : 3.99}
  6. Cliquez sur l'onglet Appeler pour appeler la ressource l'API REST.

    La réponse de l'API REST s’affiche dans l’onglet Appels distants AWS. Le corps de la réponse contient les données de ressource au format JSON.