Aplicaciones auxiliares para HTTP en $util.http

nota

Ahora admitimos de forma básica el tiempo de ejecución APPSYNC_JS y su documentación. Considere la opción de utilizar el tiempo de ejecución APPSYNC_JS y sus guías aquí.

La utilidad $util.http proporciona métodos auxiliares que puede utilizar para gestionar parámetros de solicitud HTTP y añadir encabezados de respuesta.

Lista de utilidades $util.http

$util.http.copyHeaders(Map) : Map

Copia el encabezado del mapa sin el conjunto restringido de los encabezados HTTP. Se puede usar para reenviar encabezados de solicitud al siguiente punto de conexión HTTP.

{
    ...
    "params": {
        ...
        "headers": $util.http.copyHeaders($ctx.request.headers),
        ...
    },
    ...
}

$util.http.addResponseHeader(String, Object)

Añade un único encabezado personalizado con el nombre (String) y el valor (Object) de la respuesta. Se aplican las siguientes restricciones:

• Los nombres de los encabezados no pueden coincidir con ninguno de los AWS AppSync encabezados existentes AWS o restringidos.

• Los nombres del encabezado no pueden comenzar por prefijos restringidos, como x-amzn- o x-amz-.

• El tamaño de los encabezados de respuesta personalizada no puede superar los 4 KB. Esto incluye los nombres y valores del encabezado.

• Debe definir cada encabezado de respuesta una vez por operación de GraphQL. Sin embargo, si define un encabezado personalizado con el mismo nombre varias veces, la definición más reciente aparecerá en la respuesta. Todos los encabezados se contabilizan para el límite de tamaño del encabezado independientemente de los nombres.

...
$util.http.addResponseHeader("itemsCount", 7)
$util.http.addResponseHeader("render", $ctx.args.render)
...

$util.http.addResponseHeaders(Map)

Añade varios encabezados de respuesta a la respuesta desde el mapa de nombres (String) y valores (Object) especificado. Las mismas limitaciones enumeradas para el método addResponseHeader(String, Object) también se aplican a este método.

...
#set($headersMap = {})
$util.qr($headersMap.put("headerInt", 12))
$util.qr($headersMap.put("headerString", "stringValue"))
$util.qr($headersMap.put("headerObject", {"field1": 7, "field2": "string"}))
$util.http.addResponseHeaders($headersMap)
...

Lista de utilidades $util.http

$util.http.copyHeaders(Map) : Map

Copia el encabezado del mapa sin el conjunto restringido de los encabezados HTTP. Se puede usar para reenviar encabezados de solicitud al siguiente punto de conexión HTTP.

{
    ...
    "params": {
        ...
        "headers": $util.http.copyHeaders($ctx.request.headers),
        ...
    },
    ...
}

$util.http.addResponseHeader(String, Object)

Añade un único encabezado personalizado con el nombre (String) y el valor (Object) de la respuesta. Se aplican las siguientes restricciones:

• Los nombres de los encabezados no pueden coincidir con ninguno de los AWS AppSync encabezados existentes AWS o restringidos.

• Los nombres del encabezado no pueden comenzar por prefijos restringidos, como x-amzn- o x-amz-.

• El tamaño de los encabezados de respuesta personalizada no puede superar los 4 KB. Esto incluye los nombres y valores del encabezado.

• Debe definir cada encabezado de respuesta una vez por operación de GraphQL. Sin embargo, si define un encabezado personalizado con el mismo nombre varias veces, la definición más reciente aparecerá en la respuesta. Todos los encabezados se contabilizan para el límite de tamaño del encabezado independientemente de los nombres.

...
$util.http.addResponseHeader("itemsCount", 7)
$util.http.addResponseHeader("render", $ctx.args.render)
...

$util.http.addResponseHeaders(Map)

Añade varios encabezados de respuesta a la respuesta desde el mapa de nombres (String) y valores (Object) especificado. Las mismas limitaciones enumeradas para el método addResponseHeader(String, Object) también se aplican a este método.

...
#set($headersMap = {})
$util.qr($headersMap.put("headerInt", 12))
$util.qr($headersMap.put("headerString", "stringValue"))
$util.qr($headersMap.put("headerObject", {"field1": 7, "field2": "string"}))
$util.http.addResponseHeaders($headersMap)
...