Invocation d’une API REST dans API Gateway - Amazon API Gateway
Obtention de l’URL d’invocation 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.

Invocation d’une 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’ID de l’API, region la région AWS et stage 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 apprendre à déployer une API, consultezDéploiement d’une API REST dans API Gateway.

Rubriques

Obtention de l’URL d’invocation d’une API

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

Obtention de l’URL d’invocation d’une API à l’aide de la console

La procédure suivante montre comment obtenir l’URL d’invocation d’une API dans la console API REST.

Pour obtenir l’URL d’invocation d’une API à l’aide de la console 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’invocation d’une API pour une autre ressource de votre API, développez l’étape sous le volet de navigation secondaire, puis choisissez une méthode.

  6. Choisissez l’icône de copie pour copier l’URL d’invocation de votre API au niveau des ressources.

    L’URL d’invocation de votre API REST au niveau des ressources se trouve sous le volet de navigation secondaire de l’étape.

Obtention de l’URL d’invocation d’une API à l’aide de l’AWS CLI

La procédure suivante montre comment obtenir l’URL d’invocation d’une API à l’aide de l’AWS CLI.

Pour obtenir l’URL d’invocation d’une API à l’aide de l’AWS CLI

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

    aws apigateway get-rest-apis

  2. Remplacez la valeur rest-api-id de l’exemple par votre valeur rest-api-id, remplacez la valeur {stage-name} de l’exemple par votre valeur {stage-name}, et remplacez la valeur {region} par votre région.

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

Vous pouvez également construire l’URL racine en combinant les champs host et basePath d’un fichier de définition OpenAPI exporté de l’API. Pour apprendre à exporter votre API, consultez Exportation d’une API REST à partir d’API Gateway.

Appel d’une API

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

Vous pouvez également utiliser la console API Gateway pour tester un appel d’API. Le test utilise la fonctionnalité TestInvoke d’API Gateway, qui permet de tester l’API avant son déploiement. Pour de plus amples 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 %%.

Invocation d’une API à l’aide d’un navigateur Web

Si votre API autorise les accès anonymes, vous pouvez utiliser n’importe quel navigateur web pour invoquer une méthode GET. Saisissez l’URL d’invocation 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 des données utiles ou signer les demandes. Vous pouvez gérer ces appels dans un script sous-jacent d’une page HTML ou dans une application client à l’aide d’un des kits SDK AWS.

Invocation d’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 ressource getUsers de l’étape prod 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"