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

Question

例如，如果我们想使用

GET /user?name=bob

或者

GET /user/bob

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

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

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

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

score 439 · Accepted Answer

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

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

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

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

score 232 · Accepted Answer

使这项工作的步骤是：

在 API 网关控制台中...

去Resources -> Integration Request
单击模板下拉列表旁边的加号或编辑图标（我知道，因为模板字段已经打开并且此处的按钮看起来是灰色的）
明确输入application/json内容类型字段，即使它显示默认值（如果您不这样做，它将不会保存并且不会给您错误消息）
把它放在输入映射中{ "name": "$input.params('name')" }
单击模板下拉列表旁边的复选框（我假设这是最终保存它的原因）

score 150 · Accepted Answer

我已使用此映射模板为 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
  }  
}

score 44 · Accepted Answer

These days a drop-down template is included in the API Gateway Console on AWS.

For your API, click on the resource name... then GET

Expand "Body Mapping Templates"

Type in

application/json

for Content-Type (must be explicitly typed out) and click the tick

A new window will open with the words "Generate template" and a dropdown (see image).

Select

Method Request passthrough

Then click save

To access any variables, just use the following syntax (this is Python) e.g. URL:

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

You can get variables as follows:

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'])

So there is no need to explicitly name or map each variable you desire.

score 28 · Accepted Answer

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

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

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

{
    "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 控制台中测试查询字符串参数，您需要在Method Request资源部分中定义参数名称。

注意：查看Velocity 用户指南以获取有关 Velocity 模板语言的更多信息。

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

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

score 26 · Accepted Answer

接受的答案对我来说很好，但是扩展了 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
}

score 20 · Accepted Answer

作为尝试在这里回答我自己的一个问题的一部分，我遇到了这个技巧。

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

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

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

注意：据此，仅$input.params(x)列为可用于 VTL 模板的变量。内部结构可能会发生变化并且querystring可能不再可用。

score 14 · Accepted Answer

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

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

score 12 · Accepted Answer

获取 /user?name=bob

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

获取/用户/鲍勃

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

score 8 · Accepted Answer

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

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

我认为最重要的答案在构建真实的东西时会产生更有用的东西，但是对于使用 AWS 的模板运行一个快速的 hello world 来说效果很好。

score 6 · Accepted Answer

以下参数映射示例通过 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 开发人员指南

score 6 · Accepted Answer

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

对于 GET /user?name=bob

 var name = event.queryStringParameters.name;

不过，这并不能解决 GET 用户/鲍勃问题。

score 2 · Accepted Answer

要获取查询参数，您可以queryStringParameters像这样在对象中获取它们

const name = event.queryStringParameters.name;

第二个是一个干净的 URL。如果您的路径是/user/{name}，要获取您从这样的pathParameters对象中获取的值

const name = event.pathParameters.name;

score 2 · Accepted Answer

正如@Jonathan 的回答，在Integration Request中标记Use Lambda Proxy integration之后，在您的源代码中，您应该按照以下格式实现以绕过502 Bad Gateway错误。

节点JS 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 { 路径，queryStringParameters，标题，正文 } = 事件；

score 2 · Accepted Answer

带有 boto3 v1.16v 的 Python 3.8 - 2020 年 12 月

要配置路由，您必须配置 API Gateway 以接受路由。否则，除了基本路线之外，其他一切都会以 {missing auth token} 或其他东西结束......

一旦你配置 API Gateway 接受路由，确保你启用了 lambda 代理，这样事情会更好，

访问路线，

new_route = event['path'] # /{some_url}

访问查询参数

query_param = event['queryStringParameters'][{query_key}]

score 1 · Accepted Answer

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

打开 API Gateway 资源的映射模板并添加新application/json的 content-tyap：

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

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

在 API Gateway 中，调用您的 Lambda 函数并添加以下查询字符串（例如）：param1=111&param2=222&param3=333
映射模板应在下面创建 JSON 输出，这是您的 Lambda 函数的输入。
```
{
"queryStringParameters": {"param3":"333","param1":"111","param2":"222"}
}
```
你完成了。从此时起，您的 Lambda 函数逻辑可以使用查询字符串参数。
祝你好运！

score 1 · Accepted Answer

exports.handler = async (event) => {
    let query = event.queryStringParameters;
    console.log(`id: ${query.id}`);
    const response = {
        statusCode: 200,
        body: "Hi",
    };
    return response;
};

score 0 · Accepted Answer

对我有用的方法是

转到集成请求
点击 URL 查询字符串参数
单击添加查询字符串
在名称字段中输入查询名称，这里是“名称”
在 Mapped From 字段中，输入“method.request.querystring.name”

score 0 · Accepted Answer

我的目标是传递一个类似于以下内容的查询字符串：

 protodb?sql=select * from protodb.prototab

通过来自 API 网关的 URL 到 Node.js 12 Lambda 函数。我尝试了其他答案中的一些想法，但真的想以最原生的 API 网关 UI 方式做一些事情，所以我想出了这个对我有用的方法（截至 2020 年 12 月的 API 网关 UI）：

在给定 API 的 API Gateway 控制台上的资源下，选择 get 方法。然后选择它的集成请求并在页面顶部填写 lambda 函数的数据。

滚动到底部并打开映射模板部分。如果没有定义模板（推荐），请选择 Request Body Passthrough。

单击添加映射模板并使用 application/json 的内容类型创建一个，然后单击复选标记按钮。

对于该映射模板，在下拉列表中选择 Method Request passthrough 以生成模板，该模板将使用 AWS 传递所有内容的一般方式填充其下方的文本框。

点击保存按钮。

现在，当我测试它时，我无法在 Lambda 函数中的节点 JS 下将参数作为 event.sql 通过。事实证明，当 API 网关将 URL sql 查询参数发送到 Lambda 函数时，它通过 Node.js 为：

 var insql = event.params.querystring.sql;

所以我花了一些时间的技巧是使用 JSON.stringify 来显示完整的事件堆栈，然后通过这些部分向下工作，以便能够从查询字符串中提取 sql 参数。

所以基本上你可以在 API 网关中使用默认的直通功能，诀窍是当你在 Lambda 函数中时如何传递参数。

score 0 · Accepted Answer

您可以将 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'] 等等

score 0 · Accepted Answer

参考文档： https ://docs.aws.amazon.com/apigateway/latest/developerguide/integrating-api-with-aws-services-lambda.html#api-as-lambda-proxy-expose-get-method-with -path-parameters-to-call-lambda 函数

您需要修改映射模板

score -1 · Accepted Answer

在阅读了其中几个答案后，我在 2018 年 8 月结合使用了几个答案，通过 lambda for python 3.6 检索查询字符串参数。

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

接下来，选择 Amazon 提供的 Method Request Passthrough 模板，然后选择 save and deploy your API。

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

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

22 回答 22

Related

Reference