Auxiliares HTTP em $util.http

nota

Agora, oferecemos suporte principalmente ao runtime do APPSYNC_JS e sua documentação. Considere usar o runtime do APPSYNC_JS e seus guias aqui.

O utilitário $util.http fornece métodos auxiliares que podem ser usados para gerenciar parâmetros de solicitação HTTP e adicionar cabeçalhos de resposta.

Lista de utilitários $util.http

$util.http.copyHeaders(Map) : Map

Copia o cabeçalho do mapa sem o conjunto restrito de cabeçalhos HTTP. Você pode usá-lo para encaminhar cabeçalhos de solicitação para seu endpoint HTTP downstream.

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

$util.http.addResponseHeader(String, Object)

Adiciona um único cabeçalho personalizado com o nome (String) e o valor (Object) da resposta. As limitações a seguir se aplicam a:

• Os nomes dos cabeçalhos não podem corresponder a nenhum dos AWS AppSync cabeçalhos existentes AWS ou restritos.

• Os nomes dos cabeçalhos não podem começar com prefixos restritos, como x-amzn- ou x-amz-.

• O tamanho dos cabeçalhos de resposta personalizados não pode exceder 4 KB. Isso inclui nomes e valores de cabeçalho.

• Você deve definir cada cabeçalho de resposta uma vez por operação do GraphQL. No entanto, se você definir um cabeçalho personalizado com o mesmo nome várias vezes, a definição mais recente aparecerá na resposta. Todos os cabeçalhos são contabilizados para o limite de tamanho do cabeçalho, independentemente do nome.

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

$util.http.addResponseHeaders(Map)

Adiciona vários cabeçalhos de resposta à resposta do mapa especificado de nomes (String) e valores (Object). As mesmas limitações listadas para o método addResponseHeader(String, Object) também se aplicam a esse 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)
...