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.
Utiliser un modèle de mappage pour remplacer les paramètres API de demande et de réponse et les codes d'état d'un
Les modèles de mappage de paramètres et de codes de réponse de API passerelle standard vous permettent de mapper des paramètres one-to-one et de mapper une famille de codes d'état de réponse d'intégration, assortis d'une expression régulière, à un code d'état de réponse unique. Les remplacements de modèles de mappage vous permettent d'effectuer les opérations suivantes.
-
Effectuer des mappages de many-to-one paramètres
-
Remplacer les paramètres une fois que les mappages de API passerelle standard ont été appliqués
-
Mappez les paramètres de manière conditionnelle en fonction du contenu corporel ou d'autres valeurs de paramètres
-
Création de nouveaux paramètres par programme
-
Remplacer les codes d'état renvoyés par votre point de terminaison d'intégration
N'importe quel type de paramètre de requête, en-tête de réponse ou code de statut de réponse peut être remplacé.
Cas d'utilisation pour remplacer vos paramètres API de demande et de réponse et vos codes d'état
Dans votreAPI, vous pouvez utiliser un remplacement de modèle de mappage pour API effectuer les opérations suivantes.
-
Pour créer un nouvel en-tête (ou remplacer un en-tête existant) sous la forme d'une concaténation de deux paramètres
-
Pour remplacer le code de réponse à un code de réussite ou d'échec en fonction du contenu du corps
-
Pour remapper un paramètre de façon conditionnelle, en fonction de son contenu ou du contenu d'un autre paramètre
-
Pour itérer sur le contenu d'un corps json et remapper des paires clé-valeur avec les en-têtes ou chaînes d'interrogation
Considérations relatives au remplacement de vos paramètres API de demande et de réponse et de vos codes d'état
Les considérations suivantes peuvent avoir un impact sur votre utilisation des remplacements de modèles de mappage.
-
Les remplacements par modèle de mappage ne peuvent pas être utilisés avec les points de terminaison d'intégration de proxy, lesquels ne disposent pas de mappages de données. Pour plus d'informations sur les types d'intégration, consultez Choisir un type d'intégration d’API API Gateway.
-
Les remplacement sont définitifs. Un remplacement ne peut être appliqué qu'une seule fois à chaque paramètre. Si vous essayez de remplacer le même paramètre plusieurs fois, API Gateway renvoie une
5XXréponse. Si vous devez remplacer le même paramètre plusieurs fois tout au long du modèle, nous vous recommandons de créer une variable et d'appliquer le remplacement à la fin du modèle. Le modèle n'est appliqué qu'après l'analyse complète du modèle. Pour plus d’informations, consultez Remplacez les paramètres API de demande et les en-têtes d'un utilisateur à l'aide du AWS Management Console.
Référence de remplacement du modèle de mappage
Pour créer un remplacement par modèle de mappage, utilisez une ou plusieurs des variables $context suivantes dans un modèle de mappage :
| Modèle de mappage du corps d'une requête | Modèle de mappage du corps d'une réponse |
|---|---|
$context.requestOverride.header. |
$context.responseOverride.header. |
$context.requestOverride.path. |
$context.responseOverride.status |
$context.requestOverride.querystring. |
Aucun |
Pour des exemples de remplacement des paramètres API de demande et de réponse et des codes d'état d'un utilisateur, consultezExemples de remplacement des paramètres de demande et API de réponse et des codes d'état d'un.
