x-amazon-apigateway-integration。 requestParameters 物件 - Amazon API Gateway

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

x-amazon-apigateway-integration。 requestParameters 物件

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

對於 HTTPAPIs,指定傳遞至具有指定之AWS_PROXY整合的參數integrationSubtype

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

對於 RESTAPIs,值通常是method.request.<param-type>.<param-name>格式的預先定義方法請求參數,其中<param-type>可以是querystringpathheader、或body。不過,$context.VARIABLE_NAME$stageVariables.VARIABLE_NAMESTATIC_VALUE 也是有效的值。對於body參數而言,<param-name>是不含$.前置詞的JSON路徑運算式。

parameter string

對於 HTTPAPIs,請求參數是一個鍵-值映射,指定傳遞給具有指integrationSubtypeAWS_PROXY集成的參數。您可以提供靜態值,或映射請求資料、階段變數或在執行階段評估的內容變數。如需進一步了解,請參閱HTTPAPIs在API閘道中建立 AWS 服務整合

x-amazon-apigateway-integration.requestParameters 範例

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

注意

如果您通過 Open API 或創建資源 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" },