x-amazon-apigateway-integrationrequestParameters 對象 - Amazon API Gateway

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

x-amazon-apigateway-integrationrequestParameters 對象

對於 REST API,指定從具名方法請求參數對應到整合請求參數。方法請求參數必須先定義才能參考。

對於 HTTP API,指定透過指定 AWS_PROXY 傳遞給 integrationSubtype 整合的參數。

屬性
屬性名稱 類型 描述
integration.request.<param-type>.<param-name> string

對於 REST API,該值通常是格式為 method.request.<param-type>.<param-name> 的預先定義方法請求參數,其中 <param-type> 可以是 querystringpathheaderbody。不過,$context.VARIABLE_NAME$stageVariables.VARIABLE_NAMESTATIC_VALUE 也是有效的值。至於 body 參數,<param-name> 是開頭沒有 $. 的 JSON 路徑表達式。

parameter string

對於 HTTP API,請求參數是一個金鑰值映射,指定傳遞給帶有特定 integrationSubtypeAWS_PROXY 整合。您可以提供靜態值,或映射請求資料、階段變數或在執行階段評估的內容變數。如需進一步了解,請參閱建立適用於 HTTP API 的 AWS 服務整合

x-amazon-apigateway-integration.requestParameters 範例

下列請求參數對應範例會將方法請求的查詢 (version)、標頭 (x-user-id) 和路徑 (service) 參數分別轉譯為整合請求的查詢 (stage)、標頭 (x-userid) 和路徑參數 (op)。

注意

如果您通過 OpenAPI 創建資源 AWS CloudFormation,或者靜態值應該用單引號括起來。

若要從主控台新增此值,請輸入 application/json,無需引號。

"requestParameters" : { "integration.request.querystring.stage" : "method.request.querystring.version", "integration.request.header.x-userid" : "method.request.header.x-user-id", "integration.request.path.op" : "method.request.path.service" },