以下示例显示如何使用 API Gateway 控制台、OpenAPI 和 AWS CloudFormation 模板创建参数映射表达式。有关如何使用参数映射来创建所需 CORS 标头的示例,请参阅针对 API Gateway 中的 REST API 的 CORS。
示例 1:将方法请求参数映射到集成请求参数
以下示例将方法请求标头参数 puppies
映射到集成请求标头参数 DogsAge0
。
映射方法请求参数
通过以下网址登录到 Amazon API Gateway 控制台:https://console.aws.amazon.com/apigateway
。 选择一个 REST API。
选择方法。
您的方法必须具有非代理集成。
-
对于方法请求设置,选择编辑。
选择 HTTP 请求标头。
选择添加标头。
对于名称,请输入
puppies
。选择保存。
-
选择集成请求选项卡,然后对于集成请求设置,选择编辑。
AWS Management Console会自动为您添加从
method.request.header.puppies
到puppies
的参数映射,但您需要更改名称,以匹配集成端点所期望的请求标头参数。 -
对于名称,请输入
DogsAge0
。 选择保存。
重新部署 API 以使更改生效。
以下步骤向您展示如何验证参数映射是否成功。
(可选)测试参数映射
选择测试选项卡。您可能需要选择右箭头按钮,以显示该选项卡。
对于标头,输入
puppies:true
。选择测试。
在日志中,结果应该类似以下内容:
Tue Feb 04 00:28:36 UTC 2025 : Method request headers: {puppies=true} Tue Feb 04 00:28:36 UTC 2025 : Method request body before transformations: Tue Feb 04 00:28:36 UTC 2025 : Endpoint request URI: http://petstore-demo-endpoint.execute-api.com/petstore/pets Tue Feb 04 00:28:36 UTC 2025 : Endpoint request headers: {DogsAge0=true, x-amzn-apigateway-api-id=abcd1234, Accept=application/json, User-Agent=AmazonAPIGateway_aaaaaaa, X-Amzn-Trace-Id=Root=1-abcd-12344}
请求标头参数已从
puppies
更改为DogsAge0
。
示例 2:将多个方法请求参数映射到不同的集成请求参数
以下示例将多值方法请求查询字符串参数 methodRequestQueryParam
映射到集成请求查询字符串参数 integrationQueryParam
,并将方法请求标头参数 methodRequestHeaderParam
映射到集成请求路径参数 integrationPathParam
。
映射方法请求参数
通过以下网址登录到 Amazon API Gateway 控制台:https://console.aws.amazon.com/apigateway
。 选择一个 REST API。
选择方法。
您的方法必须具有非代理集成。
-
对于方法请求设置,选择编辑。
选择 URL 查询字符串参数。
选择添加查询字符串。
在名称中,输入
methodRequestQueryParam
。选择 HTTP 请求标头。
选择添加标头。
对于名称,请输入
methodRequestHeaderParam
。选择保存。
-
选择集成请求选项卡,然后对于集成请求设置,选择编辑。
选择 URL 路径参数。
选择添加路径参数。
-
对于名称,请输入
integrationPathParam
。 对于映射自,输入
method.request.header.methodRequestHeaderParam
。这会将您在方法请求中指定的方法请求标头映射到新的集成请求路径参数。
选择 URL 查询字符串参数。
选择添加查询字符串。
-
在名称中,输入
integrationQueryParam
。 对于映射自,输入
method.request.multivaluequerystring.methodRequestQueryParam
。这会将多值查询字符串参数映射到新的单值集成请求查询字符串参数。
选择保存。
重新部署 API 以使更改生效。
示例 3:将 JSON 请求正文中的字段映射到集成请求参数
还可以使用 JSONPath expressionbody-header
的集成请求标头,并将部分请求正文(由 JSON 表达式表示)映射到名为 pet-price
的集成请求标头。
要测试此示例,请提供包含价格类别的输入,如下所示:
[ { "id": 1, "type": "dog", "price": 249.99 } ]
映射方法请求参数
通过以下网址登录到 Amazon API Gateway 控制台:https://console.aws.amazon.com/apigateway
。 选择一个 REST API。
-
选择
POST
、PUT
、PATCH
或ANY
方法。您的方法必须具有非代理集成。
-
对于集成请求设置,选择编辑。
选择 URL 请求标头参数。
选择添加请求标头参数。
-
对于名称,请输入
body-header
。 对于映射自,输入
method.request.body
。这会将方法请求正文映射到新的集成请求标头参数。
选择添加请求标头参数。
-
对于名称,请输入
pet-price
。 对于映射自,输入
method.request.body[0].price
。这会将方法请求正文的一部分映射到新的集成请求标头参数。
选择保存。
重新部署 API 以使更改生效。
示例 4:将集成响应映射到方法响应
还可以将集成响应映射到方法响应。以下示例将集成响应正文映射到名为 location
的方法响应标头,将集成响应标头 x-app-id
映射到方法响应标头 id
,并将多值集成响应标头 item
映射到方法响应标头 items
。
映射集成响应
通过以下网址登录到 Amazon API Gateway 控制台:https://console.aws.amazon.com/apigateway
。 选择一个 REST API。
选择方法。
您的方法必须具有非代理集成。
-
选择方法响应选项卡,然后对于响应 200 选择编辑。
对于标头名称,选择添加标头。
创建三个名为
id
、item
、和location
的标头。选择保存。
-
选择集成响应选项卡,然后对于默认 - 响应,选择编辑。
在标头映射下,输入以下内容。
对于 id,输入
integration.response.header.x-app-id
对于项目,输入
integration.response.multivalueheader.item
对于位置,输入
integration.response.body.redirect.url
-
选择保存。
重新部署 API 以使更改生效。