创建AWS API Gateway模板时如何保留原有event字段?
提问内容
根据相关问题的回答,我尝试使用了如下映射模板。原本我有一个名为body的传入变量,是包含多个子字段的JSON结构,但使用上述模板后该变量丢失了。
{ "client_ip" : "$input.params('X-Forwarded-For')", "user_agent" : "$input.params('User-Agent')" }
我尝试按如下方式添加body字段,但仍然无法获取带完整子字段的body内容:
{ "client_ip" : "$input.params('X-Forwarded-For')", "user_agent" : "$input.params('User-Agent')", "body": "$input.params('body')" }
我的body元素及部分子字段示例如下:
2021-06-06T13:30:01.231-05:00 pprint event: 2021-06-06T13:30:01.231-05:00 {'body': {'ResponseTimeMilliseconds': 2225, 2021-06-06T13:30:01.231-05:00 'authToken': '12312312', 2021-06-06T13:30:01.231-05:00 'handNumber': 7}}
请问我应该使用下面哪一种写法?
{ "client_ip" : "$input.params('X-Forwarded-For')", "user_agent" : "$input.params('User-Agent')", "body" : $input.json('body') }
还是
{ "client_ip" : "$input.params('X-Forwarded-For')", "user_agent" : "$input.params('User-Agent')", "body" : $input.json('$') }
我希望不需要逐一列出所有子字段。另外我只有一个测试环境,每次尝试错误方案都会影响其他使用人员。我目前参考的是AWS官方的API Gateway映射模板参考文档。
解答
你可以根据原始请求负载的结构直接选择对应方案即可:
- 如果你的原始请求负载顶层就是要保留的
body对应的JSON结构(即请求直接发送{"ResponseTimeMilliseconds": 2225, "authToken": "12312312", "handNumber": 7}),选择第二种写法 - 如果你的原始请求负载顶层本身就包含
body字段(即请求发送{"body": {"ResponseTimeMilliseconds": 2225, ...}}),选择第一种写法
关键说明
- 不要给
$input.json()的返回值加双引号:该方法的输出本身就是合法JSON片段,加引号会把整个JSON对象转义为字符串,导致无法直接访问子字段 - 之前用
$input.params('body')取不到值是正常情况:params()方法仅用于获取路径参数、查询字符串参数、请求头参数,无法读取请求体中的字段
无影响验证方法
你可以直接使用API Gateway控制台自带的测试功能验证模板效果:找到对应API的对应方法,点击「测试」按钮,自行填入测试请求头和请求体,就能直接看到映射后传递给Lambda的完整结构,整个过程不会触发真实业务调用,也不会影响其他测试人员的使用。
内容的提问来源于stack exchange,提问作者NealWalters
相关产品推荐
相关产品推荐

