如何从Amazon API Gateway将查询字符串或路由参数传递到AWS Lambda

例如，如果我们想使用

GET /user?name=bob

要么

GET /user/bob

您如何将这两个示例作为参数传递给Lambda函数？

我在文档中看到了有关设置“映射自”的信息，但是在API Gateway控制台中找不到该设置。

• method.request.path.parameter-name代表parameter-name在“方法请求”页面中定义的路径参数。
• method.request.querystring.parameter-nameparameter-name表示在“方法请求”页面中定义的查询字符串参数。

即使定义了查询字符串，我也看不到这些选项中的任何一个。

自2017年9月起，您不再需要配置映射来访问请求正文。

您需要做的就是在资源下的“集成请求”下选中“使用Lambda代理集成”。

然后，您将能够像这样访问查询参数，路径参数和标题

event['pathParameters']['param1']
event["queryStringParameters"]['queryparam1']
event['requestContext']['identity']['userAgent']
event['requestContext']['identity']['sourceIP']

使此工作正常的步骤是：

在API网关控制台中...

1. 去 Resources -> Integration Request
2. 单击模板下拉菜单旁边的加号或编辑图标（奇怪的是，因为模板字段已经打开，并且此处的按钮显示为灰色）
3. application/json即使它显示默认值，也要在content-type字段中明确输入（如果不这样做，它将不会保存，并且不会显示错误消息）

4. 将其放在输入映射中 { "name": "$input.params('name')" }

5. 单击模板下拉菜单旁边的复选框（我假设这是最终保存它的内容）

我已使用此映射模板为Lambda事件提供主体，标题，方法，路径和URL查询字符串参数。我写了一篇博客文章，更详细地解释了该模板：http : //kennbrodhagen.net/2015/12/06/how-to-create-a-request-object-for-your-lambda-event-from-api-网关/

这是您可以使用的映射模板：

{
  "method": "$context.httpMethod",
  "body" : $input.json('$'),
  "headers": {
    #foreach($param in $input.params().header.keySet())
    "$param": "$util.escapeJavaScript($input.params().header.get($param))" #if($foreach.hasNext),#end

    #end
  },
  "queryParams": {
    #foreach($param in $input.params().querystring.keySet())
    "$param": "$util.escapeJavaScript($input.params().querystring.get($param))" #if($foreach.hasNext),#end

    #end
  },
  "pathParams": {
    #foreach($param in $input.params().path.keySet())
    "$param": "$util.escapeJavaScript($input.params().path.get($param))" #if($foreach.hasNext),#end

    #end
  }  
}

如今，AWS的API网关控制台中包含一个下拉模板。

对于您的API，单击资源名称...然后单击GET。

展开“身体映射模板”

输入

应用程序/ json

对于Content-Type（必须明确输入），然后单击对勾

将打开一个新窗口，其中显示“ Generate template”字样和一个下拉菜单（参见图片）。

选择

方法请求传递

然后点击保存

要访问任何变量，只需使用以下语法（这是Python），例如URL：

https://yourURL.execute-api.us-west-2.amazonaws.com/prod/confirmReg?token=12345&uid=5

您可以按以下方式获取变量：

from __future__ import print_function

import boto3
import json

print('Loading function')


def lambda_handler(event, context):
    print(event['params']['querystring']['token'])
    print(event['params']['querystring']['uid'])

因此，无需显式命名或映射所需的每个变量。

为了将参数传递给lambda函数，您需要在API Gateway请求和lambda函数之间创建映射。映射在所选API网关资源的Integration Request-> Mapping templates部分中完成。

创建一个类型的映射application/json，然后在右侧编辑（单击铅笔）模板。

映射模板实际上是Velocity模板，您可以在其中使用ifs，loops，当然还可以在其上打印变量。模板中注入了这些变量，您可以在其中分别访问查询字符串参数，请求标头等。使用以下代码，您可以重新创建整个查询字符串：

{
    "querystring" : "#foreach($key in $input.params().querystring.keySet())#if($foreach.index > 0)&#end$util.urlEncode($key)=$util.urlEncode($input.params().querystring.get($key))#end",
    "body" : $input.json('$')
}

注意：单击对勾符号以保存模板。您可以使用资源中的“测试”按钮来测试更改。但是，为了在AWS控制台中测试querystring参数，您需要在Method Request资源部分中定义参数名称。

注意：有关Velocity模板语言的更多信息，请参见《 Velocity用户指南》。

然后，在lambda模板中，您可以执行以下操作以解析查询字符串：

var query = require('querystring').parse(event.querystring)
// access parameters with query['foo'] or query.foo

可接受的答案对我来说很好用，但是扩展了gimenete的答案，我想要一个通用模板，我可以使用它来传递所有查询/路径/标头参数（现在只是字符串），然后我提出了以下模板。我将其张贴在这里，以防有人觉得有用：

#set($keys = [])
#foreach($key in $input.params().querystring.keySet())
  #set($success = $keys.add($key))
#end

#foreach($key in $input.params().headers.keySet())
  #if(!$keys.contains($key))
    #set($success = $keys.add($key))
  #end
#end

#foreach($key in $input.params().path.keySet())
  #if(!$keys.contains($key))
    #set($success = $keys.add($key))
  #end
#end

{
#foreach($key in $keys)
  "$key": "$util.escapeJavaScript($input.params($key))"#if($foreach.hasNext),#end
#end
}

由于试图回答我自己的问题，一部分在这里，我遇到了这一招。

在API网关映射模板中，使用以下命令为您提供HTTP客户端发送的完整查询字符串：

{
    "querystring": "$input.params().querystring"
}

好处是您不必将自己限制为查询字符串中的一组预定义映射键。现在，如果您要使用这种方式，则可以接受查询字符串中的任何键值对。

注意：根据此，仅$input.params(x)列出为VTL模板可用的变量。内部可能会更改，并且querystring可能不再可用。

现在，您应该能够对Lambda使用新的代理集成类型，以自动获取标准形状的完整请求，而不是配置映射。

请参阅：http : //docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-set-up-simple-proxy.html#api-gateway-set-up-lambda-proxy-integration-on-代理资源

GET / user？name = bob

{
    "name": "$input.params().querystring.get('name')"
}

GET /用户/鲍勃

{
    "name": "$input.params('name')"
}

这里的很多答案都很棒。但是我想要一些简单的东西。我想要一些可以免费使用“ Hello World”示例的东西。这意味着我想要一个简单的产生与查询字符串匹配的请求主体：

{
#foreach($param in $input.params().querystring.keySet())
  "$param": "$util.escapeJavaScript($input.params().querystring.get($param))" #if($foreach.hasNext),#end
#end
}

我认为，在构建真实的东西时，最佳答案会产生更多有用的信息，但是使用AWS的模板来快速运行世界时，效果很好。

以下参数映射示例通过JSON有效负载将所有参数（包括路径，查询字符串和标头）传递到集成端点

#set($allParams = $input.params())
{
  "params" : {
    #foreach($type in $allParams.keySet())
    #set($params = $allParams.get($type))
    "$type" : {
      #foreach($paramName in $params.keySet())
      "$paramName" : "$util.escapeJavaScript($params.get($paramName))"
      #if($foreach.hasNext),#end
      #end
    }
    #if($foreach.hasNext),#end
    #end
  }
}

实际上，此映射模板在有效负载中输出所有请求参数，如下所示：

{
  "parameters" : {
     "path" : {    
       "path_name" : "path_value", 
       ...
     }
     "header" : {  
       "header_name" : "header_value",
       ...
     }
     'querystring" : {
       "querystring_name" : "querystring_value",
       ...
     }
   }
}

复制自Amazon API Gateway开发人员指南

查询字符串可以直接在lambda中的javascript中解析

对于GET / user？name = bob

 var name = event.params.querystring.name;

但是，这不能解决GET用户/鲍勃的问题。

作为@Jonathan的答案，在Integration Request中标记Use Lambda Proxy集成后，在您的源代码中，您应将以下格式实现为通过502 Bad Gateway错误。

NodeJS 8.10：

exports.handler = async (event, context, callback) => {
  // TODO: You could get path, parameter, headers, body value from this
  const { path, queryStringParameters, headers, body } = event;

  const response = {
    "statusCode": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": JSON.stringify({
      path, 
      query: queryStringParameters,
      headers,
      body: JSON.parse(body)
    }),
    "isBase64Encoded": false
  };

  return response;
};

重新运行API之前，请不要忘记在API Gateway上部署资源。响应JSON仅返回正文中的正确设置。因此，您可以从事件获取路径，参数，标题，正文值

const {path，queryStringParameters，headers，body} =事件；

Lambda函数需要JSON输入，因此需要解析查询字符串。解决方案是使用映射模板将查询字符串更改为JSON。
我将其用于C＃.NET Core，因此预期的输入应为带有“ queryStringParameters”参数的JSON。
请按照以下4个步骤来实现：

1. 打开API网关资源的映射模板，然后添加新的application/json内容类型：

2. 复制下面的模板，该模板将查询字符串解析为JSON，并将其粘贴到映射模板中：
   

   {
   "queryStringParameters": {#foreach($key in $input.params().querystring.keySet())#if($foreach.index > 0),#end"$key":"$input.params().querystring.get($key)"#end}
   }
   

3. 在API网关中，调用您的Lambda函数并添加以下查询字符串（例如）： param1=111&param2=222&param3=333

4. 映射模板应在下面创建JSON输出，这是Lambda函数的输入。

   {
   "queryStringParameters": {"param3":"333","param1":"111","param2":"222"}
   }
   

5. 你完成了。至此，您的Lambda函数的逻辑可以使用查询字符串参数。
   祝好运！

您可以将Lambda用作“ Lambda代理集成”，请参阅此[ https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-as-simple-proxy-for-lambda。 html＃api-gateway-proxy-integration-lambda-function-python]，适用于此lambda的选项是

对于Nodejs Lambda'event.headers'，'event.pathParameters'，'event.body'，'event.stageVariables'和'event.requestContext'

对于Python Lambda事件['headers'] ['parametername']等

请参阅文档：https : //docs.aws.amazon.com/apigateway/latest/developerguide/integrating-api-with-aws-services-lambda.html#api-as-lambda-proxy-expose-get-method-with调用lambda函数的路径参数

您需要修改映射模板

在阅读了这些答案中的几个之后，我在2018年8月使用了几个答案的组合，通过lambda为python 3.6检索了查询字符串参数。

首先，我去了API网关->我的API->资源（在左侧）->集成请求。在底部下方，选择“映射模板”，然后输入内容类型application/json。

接下来，选择Amazon提供的方法请求传递模板，然后选择保存并部署您的API。

然后，lambda event['params']是您访问所有参数的方式。对于查询字符串：event['params']['querystring']