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.
Vous pouvez configurer API Gateway afin qu’il exécute la validation d’une requête de routage avant de continuer avec la demande d’intégration. Si la validation échoue, API Gateway rejette la requête sans appeler votre back-end, envoie une réponse de passerelle « Bad request body » au client et publie les résultats de validation dans CloudWatch Logs. L’utilisation de la validation de cette façon réduit les appels inutiles vers votre back-end d’API.
Expressions de sélection du modèle
Vous pouvez utiliser une expression de sélection de modèle pour valider dynamiquement les requêtes au sein d’une même route. La validation du modèle se produit si vous fournissez une expression de sélection de modèle pour les intégrations proxy ou autres que de proxy. Vous devrez peut-être définir le modèle $default comme solution de secours si aucun modèle correspondant n’est trouvé. S’il n’y a pas de modèle correspondant et que $default n’est pas défini, la validation échoue. L’expression de sélection ressemble à Route.ModelSelectionExpression et évalue à la clé pour Route.RequestModels.
Lorsque vous définissez une route pour une API WebSocket, vous pouvez éventuellement spécifier une expression de sélection du modèle. Cette expression est évaluée pour sélectionner le modèle à utiliser pour la validation du corps lors de la réception d’une requête. L’expression correspond à l’une des entrées de l’élément d’une route requestmodels.
Un modèle est exprimé sous forme de schéma JSON
Configuration de la validation des requêtes à l’aide de la console API Gateway
L’exemple suivant vous montre comment configurer une validation des demandes sur une route.
Vous devez d’abord créer un modèle, puis une route. Ensuite, vous devez configurer la validation des demandes sur la route que vous venez de créer. Enfin, vous devez déployer et tester votre API. Pour effectuer ce didacticiel, vous avez besoin d’une API WebSocket avec $request.body.action comme expression de sélection de route et d’un point de terminaison d’intégration pour votre nouvelle route.
Vous avez également besoin de wscat pour vous connecter à votre API. Pour en savoir plus, consultez wscatÀ utiliser pour se connecter à une WebSocket API et y envoyer des messages.
Pour créer un modèle
Connectez-vous à la console API Gateway à l’adresse : https://console.aws.amazon.com/apigateway
. Choisissez une API WebSocket.
Dans le volet de navigation principal, choisissez Modèles.
Sélectionnez Create model.
Pour Name (Nom), saisissez
emailModel.Pour Type de contenu, entrez
application/json.Pour Schéma du modèle, saisissez le modèle qui suit :
{ "$schema": "http://json-schema.org/draft-04/schema#", "type" : "object", "required" : [ "address"], "properties" : { "address": { "type": "string" } } }Ce modèle nécessite que la requête contienne une adresse e-mail.
Choisissez Enregistrer.
Au cours de cette étape, vous allez créer une route pour votre API WebSocket.
Pour créer une route
Dans le volet de navigation principal, sélectionnez Routes.
Choisissez Create Route (Créer un itinéraire).
Pour Route key (Clé de route), entrez
sendMessage.Choisissez un type d’intégration et spécifiez un point de terminaison d’intégration. Pour plus d’informations, consultez Intégrations pour WebSocket APIs in API Gateway.
Choisissez Create Route (Créer un itinéraire).
Au cours de cette étape, vous allez configurer la validation des demandes pour la route sendMessage.
Pour configurer une validation des demandes
Dans l’onglet Requête de routage, sous Paramètres de requête de routage, choisissez Modifier.
Pour Expression de sélection de modèle, saisissez
${request.body.messageType}.API Gateway utilise la propriété
messageTypepour valider la requête entrante.Choisissez Ajouter un modèle de requête.
Pour Clé de modèle, saisissez
email.Pour Modèle, choisissez emailModel.
API Gateway valide les messages entrants avec la propriété
messageTypedéfinie suremailpour ce modèle.Note
Si API Gateway ne parvient pas à faire correspondre l’expression de sélection du modèle à une clé de modèle, le modèle
$defaultest sélectionné. S’il n’y a pas de modèle$default, la validation échoue. Pour les API de production, nous vous recommandons de créer un modèle$default.Sélectionnez Enregistrer les modifications.
Au cours de cette étape, vous allez déployer et tester votre API.
Pour déployer et tester votre API
Sélectionnez Deploy API (Déployer une API).
Choisissez l’étape souhaitée dans la liste déroulante ou saisissez le nom d’une nouvelle étape.
Choisissez Deploy (Déployer).
Dans le volet de navigation principal, choisissez Étapes.
Copiez l’URL WebSocket de votre API. L’URL doit ressembler à
wss://.abcdef123.execute-api.us-east-2.amazonaws.com/productionOuvrez un nouveau terminal et exécutez la commande wscat avec les paramètres suivants.
wscat -c wss://abcdef123.execute-api.us-west-2.amazonaws.com/productionConnected (press CTRL+C to quit)
Utilisez la commande suivante pour tester votre API.
{"action": "sendMessage", "messageType": "email"}{"message": "Invalid request body", "connectionId":"ABCD1=234", "requestId":"EFGH="}API Gateway rejettera la requête.
Utilisez la commande suivante pour envoyer une demande valide à votre API.
{"action": "sendMessage", "messageType": "email", "address": "mary_major@example.com"}
