$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)

() という名前のカスタムヘッダーを 1 つ追加します。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) と値 (Object). に挙げられているものと同じ制限事項があります。addResponseHeader(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) ...