Invoquer des API REST dans API Gateway - APIPasserelle Amazon
Obtention de l'URL d'appel d'une APIAppel d'une API

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.

Invoquer des API REST dans API Gateway

Pour appeler une API déployée, les clients soumettent des demandes à l'URL du service des composants API Gateway pour l'exécution de l'API, connu sous le nom de execute-api.

L'URL de base pour les API REST se présente au format suivant : 

https://api-id.execute-api.region.amazonaws.com/stage/

où api-id est l'identifiant de l'API, region est la AWS région et stage est le nom de l'étape du déploiement de l'API.

Important

Avant de pouvoir invoquer une API, vous devez la déployer dans API Gateway. Pour obtenir des instructions sur le déploiement d'une API, consultezDéploiement REST APIs dans API Gateway.

Rubriques

Obtention de l'URL d'appel d'une API

Vous pouvez utiliser la console, le AWS CLI, ou une définition OpenAPI exportée pour obtenir l'URL d'appel d'une API.

Obtention de l'URL d'appel d'une API à l'aide de la console

La procédure suivante montre comment obtenir l'URL d'appel d'une API dans la console de l'API REST.

Pour obtenir l'URL d'appel d'une API à l'aide de la console d'API REST

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

  2. Choisissez une API déployée.

  3. Dans le panneau de navigation principal, choisissez Étape.

  4. Sous Détails de l'étape, choisissez l'icône de copie pour copier l'URL d'invocation de votre API.

    Cette URL est destinée à la ressource racine de votre API.

    Une fois que vous avez créé votre API REST, la console affiche l'URL d'invocation de votre API.

  5. Pour obtenir l'URL d'appel d'une API pour une autre ressource de votre API, développez la scène sous le volet de navigation secondaire, puis choisissez une méthode.

  6. Cliquez sur l'icône de copie pour copier l'URL d'appel au niveau des ressources de votre API.

    L'URL au niveau des ressources de votre API REST se trouve sous le volet de navigation secondaire de la scène.

Obtention de l'URL d'appel d'une API à l'aide du AWS CLI

La procédure suivante montre comment obtenir l'URL d'appel d'une API à l'aide du AWS CLI.

Pour obtenir l'URL d'appel d'une API à l'aide du AWS CLI

  1. Utilisez la commande suivante pour obtenir lerest-api-id. Cette commande renvoie toutes les rest-api-id valeurs de votre région. Pour plus d'informations, consultez get-rest-apis.

    aws apigateway get-rest-apis

  2. Remplacez l'exemple rest-api-id par votrerest-api-id, remplacez l'exemple {stage-name} par votre {stage-name}, et remplacez {region} par votre région.

    https://{restapi_id}.execute-api.{region}.amazonaws.com/{stage_name}/
Obtention de l'URL d'appel d'une API à l'aide du fichier de définition OpenAPI exporté de l'API

Vous pouvez également créer l'URL racine en combinant les basePath champs host et d'un fichier de définition OpenAPI exporté de l'API. Pour obtenir des instructions sur la façon d'exporter votre API, consultezExporter un REST API fichier depuis API Gateway.

Appel d'une API

Vous pouvez appeler votre API déployée à l'aide du navigateur, de curl ou d'autres applications, telles que Postman.

En outre, vous pouvez utiliser la console API Gateway pour tester un appel d'API. Le test utilise la TestInvoke fonctionnalité d'API Gateway, qui permet de tester l'API avant le déploiement de l'API. Pour plus d’informations, consultez Utilisation de la console API Gateway pour tester une méthode API REST.

Note

Les valeurs de paramètres de chaîne de requêtes d'une URL d'invocation ne peuvent pas contenir %%.

Invoquer une API à l'aide d'un navigateur Web

Si votre API autorise un accès anonyme, vous pouvez utiliser n'importe quel navigateur Web pour appeler n'importe quelle GET méthode. Entrez l'URL d'appel complète dans la barre d'adresse du navigateur.

Pour les autres méthodes ou les appels nécessitant une authentification, vous devez spécifier une charge utile ou signer les demandes. Vous pouvez les gérer dans un script derrière une page HTML ou dans une application cliente à l'aide de l'un des AWS SDK.

Invoquer une API à l'aide de curl

Vous pouvez utiliser un outil tel que curl dans votre terminal pour appeler votre API. L'exemple de commande curl suivant invoque la méthode GET sur la getUsers ressource du prod stage d'une API.

Linux or Macintosh
curl -X GET 'https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers'
Windows
curl -X GET "https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers"