วิธีส่งพารามิเตอร์ตัวสอบถามหรือเส้นทางไปยัง AWS Lambda จาก Amazon API Gateway

เช่นถ้าเราต้องการใช้

GET /user?name=bob

หรือ

GET /user/bob

คุณจะส่งตัวอย่างทั้งสองนี้เป็นพารามิเตอร์ไปยังฟังก์ชัน Lambda ได้อย่างไร

ฉันเห็นบางอย่างเกี่ยวกับการตั้งค่า "แมปจาก" ในเอกสารประกอบ แต่ฉันไม่พบการตั้งค่านั้นในคอนโซล API เกตเวย์

• method.request.path.parameter-nameสำหรับพารามิเตอร์พา ธ ที่มีชื่อparameter-nameตามที่กำหนดไว้ในหน้าคำขอวิธีการ
• method.request.querystring.parameter-nameสำหรับพารามิเตอร์สตริงแบบสอบถามที่มีชื่อparameter-nameตามที่กำหนดไว้ในหน้าคำขอวิธีการ

ฉันไม่เห็นตัวเลือกเหล่านี้แม้ว่าฉันจะกำหนดสตริงข้อความค้นหา

ตั้งแต่เดือนกันยายน 2017 คุณไม่จำเป็นต้องกำหนดค่าการแมปเพื่อเข้าถึงเนื้อหาคำขออีกต่อไป

สิ่งที่คุณต้องทำคือตรวจสอบ "ใช้การรวม Lambda Proxy" ภายใต้คำขอการรวมระบบภายใต้ทรัพยากร

จากนั้นคุณจะสามารถเข้าถึงพารามิเตอร์ข้อความค้นหาพารามิเตอร์เส้นทางและส่วนหัวได้

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

ขั้นตอนในการทำงานนี้คือ:

ภายในคอนโซลของ API เกตเวย์ ...

1. ไปที่ Resources -> Integration Request
2. คลิกที่ไอคอนเครื่องหมายบวกหรือแก้ไขถัดจากดรอปดาวน์เทมเพลต (แปลกที่ฉันรู้เนื่องจากฟิลด์เทมเพลตเปิดอยู่แล้วและปุ่มที่นี่ดูเป็นสีเทา)
3. พิมพ์อย่างชัดเจนapplication/jsonในฟิลด์ประเภทเนื้อหาแม้ว่าจะแสดงค่าเริ่มต้น (ถ้าคุณไม่ทำเช่นนี้มันจะไม่บันทึกและจะไม่ให้ข้อความผิดพลาด)

4. วางสิ่งนี้ในการแม็พอินพุต { "name": "$input.params('name')" }

5. คลิกที่ช่องทำเครื่องหมายถัดจากรายการแบบเลื่อนลงของแม่แบบ (ฉันสมมติว่านี่คือสิ่งที่บันทึกไว้ในที่สุด)

ฉันใช้เทมเพลตการแมปนี้เพื่อจัดเตรียมพารามิเตอร์ส่วนหัว, ส่วนหัว, วิธีการและเส้นทาง 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
  }  
}

ทุกวันนี้เทมเพลตดร็อปดาวน์จะรวมอยู่ใน API เกตเวย์คอนโซลบน AWS

สำหรับ API ของคุณคลิกที่ชื่อทรัพยากร ... จากนั้นรับ

ขยาย "เทมเพลตการแมปเนื้อหา"

พิมพ์ใน

แอพลิเคชัน / JSON

สำหรับ Content-Type (ต้องพิมพ์อย่างชัดเจน) และคลิกที่เครื่องหมาย

หน้าต่างใหม่จะเปิดขึ้นพร้อมคำว่า "สร้างเทมเพลต" และดร็อปดาวน์ (ดูภาพ)

เลือก

ขอวิธีการส่งผ่าน

จากนั้นคลิกบันทึก

ในการเข้าถึงตัวแปรใด ๆ ให้ใช้ไวยากรณ์ต่อไปนี้ (นี่คือ 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'])

ดังนั้นจึงไม่จำเป็นต้องตั้งชื่อหรือแมปตัวแปรแต่ละตัวที่คุณต้องการอย่างชัดเจน

ในการส่งพารามิเตอร์ไปยังฟังก์ชั่นแลมบ์ดาคุณต้องสร้างการแมประหว่างคำขอ API เกตเวย์และฟังก์ชั่นแลมบ์ดาของคุณ การแมปเสร็จในส่วนIntegration Request-> Mapping templatesของทรัพยากร API เกตเวย์ที่เลือก

สร้างการแมปประเภท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 คุณจะต้องกำหนดชื่อพารามิเตอร์ในMethod Requestส่วนของทรัพยากรของคุณ

หมายเหตุ: ตรวจสอบคู่มือผู้ใช้ Velocityสำหรับข้อมูลเพิ่มเติมเกี่ยวกับภาษาเทมเพลต Velocity

จากนั้นในแลมบ์ดาเทมเพลตของคุณคุณสามารถทำสิ่งต่อไปนี้เพื่อรับการวิเคราะห์คำ:

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 Gateway ให้ใช้ข้อมูลต่อไปนี้เพื่อให้สตริงการสืบค้นที่สมบูรณ์ตามที่ส่งโดยไคลเอนต์ HTTP:

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

ข้อได้เปรียบคือคุณไม่จำเป็นต้อง จำกัด ตัวเองให้เป็นชุดของคีย์ที่แมปที่กำหนดไว้ล่วงหน้าในสตริงการสืบค้นของคุณ ตอนนี้คุณสามารถยอมรับคู่คีย์ - ค่าใด ๆ ในสตริงเคียวรีหากนี่คือวิธีที่คุณต้องการจัดการ

หมายเหตุ: ตามนี้เท่านั้นที่$input.params(x)ถูกระบุว่าเป็นตัวแปรทำให้พร้อมสำหรับแม่แบบ VTL เป็นไปได้ว่าภายในอาจมีการเปลี่ยนแปลงและquerystringอาจไม่สามารถใช้งานได้อีกต่อไป

ตอนนี้คุณควรจะสามารถใช้ประเภทการรวมพร็อกซีใหม่สำหรับแลมบ์ดาเพื่อรับคำขอแบบเต็มโดยอัตโนมัติในรูปแบบมาตรฐานแทนที่จะกำหนดค่าการแมป

ดู: 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 / user / bob

{
    "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
}

ฉันคิดว่าคำตอบยอดนิยมสร้างสิ่งที่มีประโยชน์มากขึ้นเมื่อสร้างของจริง แต่สำหรับการเรียกใช้ Hello World อย่างรวดเร็วโดยใช้เทมเพลตจาก AWS สิ่งนี้ใช้งานได้ดี

ตัวอย่างการแม็พพารามิเตอร์ต่อไปนี้ส่งผ่านพารามิเตอร์ทั้งหมดรวมถึงพา ธ การสอบถามและส่วนหัวจนถึงจุดสิ้นสุดการรวมผ่านทาง JSON payload

#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",
       ...
     }
   }
}

คัดลอกมาจากคู่มือผู้พัฒนาเกตเวย์ API ของ Amazon

สตริงแบบสอบถามตรงไปข้างหน้าเพื่อแจงในจาวาสคริปต์ในแลมบ์ดา

สำหรับ GET / user? name = bob

 var name = event.params.querystring.name;

นี่ไม่ได้แก้คำถามผู้ใช้ / บ๊อบ GET

ในฐานะที่เป็นคำตอบของ @ Jonathan หลังจากทำเครื่องหมายใช้การรวม Lambda ProxyในIntegration Requestในซอร์สโค้ดของคุณคุณควรใช้รูปแบบด้านล่างเพื่อผ่านข้อผิดพลาดBad Pass 502

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 Gateway ก่อนที่จะเรียกใช้ API ของคุณอีกครั้ง JSON เพียงแค่ส่งคืนชุดของเนื้อหาที่ถูกต้อง ดังนั้นคุณสามารถรับพา ธ พารามิเตอร์ส่วนหัวค่าเนื้อความจากเหตุการณ์

const {เส้นทาง, queryStringParameters, ส่วนหัว, ร่างกาย} = เหตุการณ์;

ฟังก์ชัน Lambda ต้องการอินพุต JSON ดังนั้นจึงจำเป็นต้องแยกสตริงการสืบค้น วิธีแก้ไขคือเปลี่ยนสตริงแบบสอบถามเป็น JSON โดยใช้เทมเพลตการทำแผนที่
ฉันใช้มันสำหรับ C # .NET Core ดังนั้นอินพุตที่คาดหวังควรเป็น JSON ด้วยพารามิเตอร์ "queryStringParameters"
ทำตาม 4 ขั้นตอนด้านล่างเพื่อบรรลุเป้าหมายดังกล่าว:

1. เปิดเทมเพลตการแมปของทรัพยากร API Gateway ของคุณและเพิ่มapplication/jsoncontent-tyap ใหม่:

2. คัดลอกแม่แบบด้านล่างซึ่งแยกวิเคราะห์สตริงแบบสอบถามลงใน JSON และวางลงในเทมเพลตการทำแผนที่:
   

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

3. ใน API Gateway ให้เรียกใช้ฟังก์ชัน Lambda ของคุณและเพิ่มสตริงการสืบค้นต่อไปนี้ (ตัวอย่าง): param1=111&param2=222&param3=333

4. เทมเพลตการแมปควรสร้างเอาต์พุต JSON ด้านล่างซึ่งเป็นอินพุตสำหรับฟังก์ชันแลมบ์ดาของคุณ

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

5. คุณทำเสร็จแล้ว จากจุดนี้ตรรกะของฟังก์ชันแลมบ์ดาของคุณสามารถใช้พารามิเตอร์สตริงแบบสอบถาม
   โชคดี!

คุณสามารถใช้ Lambda เป็น"Lambda Proxy Integration"อ้างอิง [ 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'] เป็นต้น

อ้างอิง Doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/integrating-api-with-aws-services-lambda.html#api-as-lambda-proxy-expose-get-method-with -path พารามิเตอร์เพื่อโทรแลมบ์ดาฟังก์ชั่น

คุณต้องแก้ไขเทมเพลตการทำแผนที่

หลังจากอ่านคำตอบเหล่านี้หลายข้อฉันใช้การรวมกันของคำตอบหลายข้อในเดือน ส.ค. 2018 เพื่อเรียกค้นพารามิเตอร์ params ผ่าน lambda สำหรับ python 3.6

ก่อนอื่นฉันไปที่เกตเวย์ API -> API ของฉัน -> ทรัพยากร (ด้านซ้าย) -> คำขอการรวมระบบ application/jsonลงที่ด้านล่างให้เลือกทำแผนที่แม่แบบแล้วสำหรับประเภทเนื้อหาใส่

จากนั้นเลือกเทมเพลตคำขอ Passthrough ที่ Amazon จัดเตรียมและเลือกบันทึกและปรับใช้ API ของคุณ

จากนั้นในแลมบ์ดาevent['params']เป็นวิธีที่คุณเข้าถึงพารามิเตอร์ทั้งหมดของคุณ สำหรับสตริงการสืบค้น:event['params']['querystring']