Las plantillas de asignación de parámetros y códigos de respuesta de API Gateway estándar le permiten asignar parámetros uno a uno y asignar una familia de códigos de estado de respuesta de integración, que coinciden con una expresión regular, a un único código de estado de respuesta. Las anulaciones de plantilla de asignación le permiten hacer lo siguiente.
-
Realizar asignaciones de parámetros muchos a uno
-
Anular parámetros una vez aplicadas las asignaciones de API Gateway estándar
-
Asignar parámetros condicionalmente en función del contenido del cuerpo u otros valores de parámetro
-
Crear nuevos parámetros mediante programación
-
Anular los códigos de estado devueltos por el punto de conexión de integración
Se puede invalidar cualquier tipo de parámetro de solicitud, encabezado de respuesta o código de estado de respuesta.
Casos de uso para anular los parámetros de solicitud y respuesta y los códigos de estado de la API
En la API, puede utilizar una anulación de plantilla de asignación para que su API haga lo siguiente.
-
Para crear un nuevo encabezado (o sobrescribir una encabezado existente) como una concatenación de dos parámetros
-
Para invalidar el código de respuesta a un código de éxito o error en función del contenido del cuerpo
-
Para reasignar condicionalmente un parámetro en función de su contenido o del contenido de cualquier otro parámetro
-
Para iterar sobre el contenido de un cuerpo JSON y reasignar pares de clave-valor a encabezados o cadenas de consulta
Consideraciones para anular los parámetros de solicitud y respuesta y los códigos de estado de la API
Las siguientes consideraciones pueden afectar al uso de anulación de plantillas de asignación.
-
Las invalidaciones de plantillas de asignación no pueden utilizarse con puntos de enlace de integración de proxy, que carecen de asignaciones de datos. Para obtener más información acerca de los tipos de integración, consulte Elegir un tipo de integración de API de API Gateway.
-
Las invalidaciones son definitivas. Una invalidación solo puede aplicarse a cada parámetro una vez. Si intenta anular el mismo parámetro varias veces, API Gateway devuelve una respuesta
5XX. Si tiene que invalidar el mismo parámetro varias veces en la plantilla, le recomendamos crear una variable y aplicar la invalidación al final de la plantilla. La plantilla solo se aplica una vez analizada en su totalidad. Para obtener más información, consulte Anulación de los parámetros y los encabezados de solicitud de una API mediante la AWS Management Console
Referencia de anulación de plantilla de asignación
Para crear una invalidación de plantilla de asignación, utilice una o varias de las siguientes $context variables en una plantilla de asignación:
| Plantilla de mapeo del cuerpo de solicitud | Plantilla de mapeo del cuerpo de respuesta |
|---|---|
$context.requestOverride.header. |
$context.responseOverride.header. |
$context.requestOverride.path. |
$context.responseOverride.status |
$context.requestOverride.querystring. |
Ninguno |
Para obtener ejemplos de cómo anular los parámetros de solicitud y respuesta y los códigos de estado de una API, consulte Ejemplos de anulación de los parámetros de solicitud y respuesta y de los códigos de estado de una API.
