Méthodes pour REST APIs in API Gateway

Dans API Gateway, une API méthode incarne une demande de méthode et une réponse de méthode. Vous configurez une API méthode pour définir ce qu'un client doit ou doit faire pour soumettre une demande d'accès au service en arrière-plan et pour définir les réponses que le client reçoit en retour. Pour l'entrée, vous pouvez choisir les paramètres de demande de méthode (ou une charge utile applicable) pour que le client fournisse les données obligatoires ou facultatives au moment de l'exécution. Pour la sortie, vous déterminez le code de statut, les en-têtes et le corps applicable de la réponse de la méthode en tant que cibles auxquelles mapper les données de réponse du backend, avant qu'elles ne soient renvoyés au client. Pour aider le développeur client à comprendre les comportements et les formats d'entrée et de sortie de vos demandesAPI, vous pouvez documenter vos demandes API et fournir des messages d'erreur appropriés pour les demandes non valides.

Une demande de API méthode est une HTTP demande. Pour configurer la demande de méthode, vous configurez une HTTP méthode (ou un verbe), le chemin d'accès à une API ressource, les en-têtes et les paramètres de chaîne de requête applicables. Vous configurez également une charge utile lorsque la HTTP méthode est POSTPUT, ouPATCH. Par exemple, pour récupérer un animal domestique à l'aide de l'PetStore exemple API, vous définissez la requête de API méthodeGET /pets/{petId}, où se {petId} trouve un paramètre de chemin pouvant prendre un nombre au moment de l'exécution.

GET /pets/1
Host: apigateway.us-east-1.amazonaws.com
...

Si le client spécifie un chemin d'accès incorrect, par exemple /pet/1 ou /pets/one au lieu de /pets/1, une exception est renvoyée.

Une réponse de API méthode est une HTTP réponse avec un code d'état donné. Dans le cas d'une intégration autre que de proxy, vous devez configurer les réponses de méthode afin de spécifier les cibles obligatoires ou facultatives des mappages. Cela permet de transformer les en-têtes ou corps de la réponse d'intégration en en-têtes ou corps de la réponse de méthode associée. Le mappage peut être aussi simple qu'une transformation d'identité qui transmet les en-têtes ou le corps via l'intégration en l'état. Par exemple, la réponse de méthode 200 suivante illustre un exemple de transfert d'une réponse d'intégration positive telle quelle.

200 OK 
Content-Type: application/json
...

{
    "id": "1",
    "type": "dog",
    "price": "$249.99"
}

En principe, vous pouvez définir une réponse de méthode correspondant à une réponse spécifique à partir du backend. En général, cela implique n'importe quelle réponse 2XX, 4XX et 5XX. Toutefois, il se peut que ce ne soit pas pratique, car souvent, vous ne connaissez pas forcément à l'avance toutes les réponses qu'un backend peut renvoyer. En pratique, vous pouvez désigner une réponse de méthode par défaut pour gérer l'inconnu ou des réponses non mappées depuis le backend. Il est recommandé de désigner la réponse 500 comme valeur par défaut. Dans tous les cas, vous devez configurer au moins une réponse de méthode pour les intégrations autres que de proxy. Dans le cas contraire, API Gateway renvoie une réponse d'erreur 500 au client, même si la demande aboutit au niveau du backend.

Pour prendre en charge un type fortement typéSDK, tel qu'un Java SDKAPI, vous devez définir le modèle de données pour l'entrée de la demande de méthode, et définir le modèle de données pour la sortie de la réponse de la méthode.

Prérequis

Avant de configurer une API méthode, vérifiez les points suivants :