$util.http の HTTP ヘルパー - AWS AppSync

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

$util.http の HTTP ヘルパー

$util.httpこのユーティリティには、HTTP 要求パラメータの管理や応答ヘッダーの追加に使用できるヘルパーメソッドが用意されています。

$util.http.copyHeaders(Map) : Map

制限された HTTP ヘッダーのセットなしでマップからヘッダーをコピーします。これを使用して、リクエストヘッダーをダウンストリーム HTTP エンドポイントに転送できます。

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

応答の名前 (String) と値 (Object) を含む単一のカスタムヘッダーを追加します。以下の制限が適用されます。

  • ヘッダー名は、既存のヘッダー、制限付きAWS、AWS AppSyncまたはヘッダーのいずれにも一致できません。

  • ヘッダー名の先頭に、x-amzn-またはなどの制限付きプレフィックスを使用することはできませんx-amz-。

  • カスタム応答ヘッダーのサイズは 4 KB を超えることはできません。これにはヘッダ名と値が含まれます。

  • 各レスポンスヘッダーは、GraphQL オペレーションごとに 1 回定義する必要があります。ただし、同じ名前のカスタムヘッダーを複数回定義すると、最新の定義が応答に表示されます。名前に関係なく、すべてのヘッダーがヘッダーサイズの制限にカウントされます。

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

指定された名前 (String) と値のマップ () からの応答に複数の応答ヘッダーを追加します。ObjectaddResponseHeader(String, Object)この方法に記載されているのと同じ制限がこの方法にも適用されます。

...
#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)
...