Cách chuyển một chuỗi truy vấn hoặc tham số tuyến đến AWS Lambda từ Amazon API Gateway

ví dụ nếu chúng ta muốn sử dụng

GET /user?name=bob

hoặc là

GET /user/bob

Làm thế nào bạn sẽ vượt qua cả hai ví dụ này như là một tham số cho hàm Lambda?

Tôi đã thấy điều gì đó về việc đặt "ánh xạ từ" trong tài liệu, nhưng tôi không thể tìm thấy cài đặt đó trong bảng điều khiển API Gateway.

• method.request.path.parameter-namecho một tham số đường dẫn có tên parameter-namenhư được xác định trong trang Yêu cầu phương thức.
• method.request.querystring.parameter-namecho một tham số chuỗi truy vấn có tên parameter-namenhư được xác định trong trang Yêu cầu phương thức.

Tôi không thấy một trong các tùy chọn này mặc dù tôi đã xác định chuỗi truy vấn.

Kể từ tháng 9 năm 2017, bạn không còn phải định cấu hình ánh xạ để truy cập vào thân yêu cầu.

Tất cả những gì bạn cần làm là kiểm tra "Sử dụng tích hợp Lambda Proxy", trong Yêu cầu tích hợp, trong tài nguyên.

Sau đó, bạn sẽ có thể truy cập các tham số truy vấn, tham số đường dẫn và tiêu đề như vậy

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

Các bước để làm việc này là:

Trong Bảng điều khiển API Gateway ...

1. đi đến Resources -> Integration Request
2. nhấp vào biểu tượng dấu cộng hoặc chỉnh sửa bên cạnh thả xuống mẫu (lẻ tôi biết vì trường mẫu đã mở và nút ở đây có vẻ hơi mờ)
3. Nhập hoàn toàn application/jsonvào trường loại nội dung mặc dù nó hiển thị mặc định (nếu bạn không làm điều này, nó sẽ không lưu và sẽ không cung cấp cho bạn một thông báo lỗi)

4. đặt cái này vào ánh xạ đầu vào { "name": "$input.params('name')" }

5. nhấp vào hộp kiểm bên cạnh danh sách thả xuống mẫu (Tôi giả sử đây là thứ cuối cùng lưu nó)

Tôi đã sử dụng mẫu ánh xạ này để cung cấp Tham số chuỗi truy vấn cơ thể, tiêu đề, phương thức, đường dẫn và URL cho sự kiện Lambda. Tôi đã viết một bài đăng trên blog giải thích mẫu chi tiết hơn: http://kennbrodhagen.net/2015/12/06/how-to-create-a-request-object-for-your-lambda-event-from-api- cổng /

Đây là Mẫu bản đồ bạn có thể sử dụng:

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

Ngày nay, mẫu thả xuống được bao gồm trong Bảng điều khiển API Gateway trên AWS.

Đối với API của bạn, nhấp vào tên tài nguyên ... sau đó NHẬN

Mở rộng "Mẫu bản đồ cơ thể"

Gõ vào

ứng dụng / json

cho Kiểu nội dung (phải được gõ rõ ràng) và nhấp vào đánh dấu

Một cửa sổ mới sẽ mở ra với dòng chữ "Tạo mẫu" và thả xuống (xem hình ảnh).

Lựa chọn

Phương thức Yêu cầu thông qua

Sau đó bấm lưu

Để truy cập bất kỳ biến nào, chỉ cần sử dụng cú pháp sau (đây là Python), vd: URL:

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

Bạn có thể nhận được các biến như sau:

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

Vì vậy, không cần phải đặt tên rõ ràng hoặc ánh xạ từng biến bạn muốn.

Để truyền tham số cho hàm lambda của bạn, bạn cần tạo ánh xạ giữa yêu cầu API Gateway và hàm lambda của bạn. Ánh xạ được thực hiện trong phần Integration Request-> Mapping templatescủa tài nguyên API Gateway đã chọn.

Tạo một bản đồ loại application/json, sau đó ở bên phải bạn sẽ chỉnh sửa (nhấp vào bút chì) mẫu.

Mẫu ánh xạ thực sự là một mẫu Vận tốc trong đó bạn có thể sử dụng if, vòng lặp và tất nhiên là in các biến trên đó. Mẫu có các biến này được chèn vào nơi bạn có thể truy cập các tham số chuỗi truy vấn, tiêu đề yêu cầu, v.v. Với đoạn mã sau, bạn có thể tạo lại toàn bộ chuỗi truy vấn:

{
    "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('$')
}

Lưu ý: nhấp vào biểu tượng kiểm tra để lưu mẫu. Bạn có thể kiểm tra các thay đổi của mình bằng nút "kiểm tra" trong tài nguyên của mình. Nhưng để kiểm tra các tham số chuỗi truy vấn trong bảng điều khiển AWS, bạn sẽ cần xác định tên tham số trong Method Requestphần tài nguyên của mình.

Lưu ý: kiểm tra Hướng dẫn sử dụng Velocity để biết thêm thông tin về ngôn ngữ tạo khuôn mẫu Vận tốc.

Sau đó, trong mẫu lambda của bạn, bạn có thể làm như sau để có được chuỗi truy vấn được phân tích cú pháp:

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

Câu trả lời được chấp nhận hoạt động tốt với tôi, nhưng mở rộng dựa trên câu trả lời của gimenete, tôi muốn có một mẫu chung mà tôi có thể sử dụng để vượt qua tất cả các tham số truy vấn / đường dẫn / tiêu đề (giống như các chuỗi bây giờ) và tôi đã đưa ra mẫu sau. Tôi đang đăng nó ở đây trong trường hợp ai đó thấy nó hữu ích:

#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
}

Là một phần của việc cố gắng trả lời một trong những câu hỏi của riêng tôi ở đây , tôi đã tìm ra mẹo này.

Trong mẫu ánh xạ Cổng API, sử dụng thông tin sau để cung cấp cho bạn chuỗi truy vấn hoàn chỉnh như được gửi bởi ứng dụng khách HTTP:

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

Ưu điểm là bạn không phải giới hạn bản thân trong một tập hợp các khóa được ánh xạ được xác định trước trong chuỗi truy vấn của bạn. Bây giờ bạn có thể chấp nhận bất kỳ cặp khóa-giá trị nào trong chuỗi truy vấn, nếu đây là cách bạn muốn xử lý.

Lưu ý: Theo đó , chỉ $input.params(x)được liệt kê dưới dạng một biến có sẵn cho mẫu VTL. Có thể là nội bộ có thể thay đổi và querystringcó thể không còn có sẵn.

Bây giờ bạn sẽ có thể sử dụng loại tích hợp proxy mới cho Lambda để tự động nhận yêu cầu đầy đủ trong hình dạng tiêu chuẩn, thay vì định cấu hình ánh xạ.

xem: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-set-up-simple-proxy.html#api-gateway-set-up-lambda-proxy-integration-on- tài nguyên proxy

NHẬN / người dùng? Tên = bob

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

NHẬN / người dùng / bob

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

Rất nhiều câu trả lời ở đây là tuyệt vời. Nhưng tôi muốn một cái gì đó đơn giản hơn một chút. Tôi muốn một cái gì đó sẽ hoạt động với mẫu "Hello World" miễn phí. Điều này có nghĩa là tôi muốn một đơn giản tạo ra một thân yêu cầu khớp với chuỗi truy vấn:

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

Tôi nghĩ rằng câu trả lời hàng đầu tạo ra một cái gì đó hữu ích hơn khi xây dựng một cái gì đó thực sự, nhưng để có được một thế giới xin chào nhanh chóng chạy bằng cách sử dụng mẫu từ AWS, điều này hoạt động rất tốt.

Ví dụ ánh xạ tham số sau đây chuyển tất cả các tham số, bao gồm đường dẫn, chuỗi truy vấn và tiêu đề, đến điểm cuối tích hợp thông qua tải trọng 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
  }
}

Trong thực tế, mẫu ánh xạ này xuất ra tất cả các tham số yêu cầu trong tải trọng như được nêu như sau:

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

Sao chép từ Hướng dẫn dành cho nhà phát triển Amazon API Gateway

Chuỗi truy vấn được chuyển thẳng sang phân tích cú pháp trong javascript trong lambda

cho GET / người dùng? name = bob

 var name = event.params.querystring.name;

Điều này không giải quyết được câu hỏi GET user / bob.

Như câu trả lời của @ Jonathan, sau khi đánh dấu Sử dụng tích hợp Lambda Proxy trong Yêu cầu tích hợp , trong mã nguồn của bạn, bạn nên triển khai theo định dạng dưới đây để vượt qua lỗi 502 Cổng xấu .

Nút Node 8.1:

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;
};

Đừng quên triển khai tài nguyên của bạn tại API Gateway trước khi chạy lại API của bạn. Phản hồi JSON chỉ trả về bộ nào trong thân là chính xác. Vì vậy, bạn có thể nhận được đường dẫn, tham số, tiêu đề, giá trị cơ thể từ sự kiện

const {path, queryStringParameter, headers, body} = event;

Hàm Lambda mong đợi đầu vào JSON, do đó phân tích chuỗi truy vấn là cần thiết. Giải pháp là thay đổi chuỗi truy vấn thành JSON bằng Mẫu ánh xạ.
Tôi đã sử dụng nó cho C # .NET Core, vì vậy, đầu vào dự kiến ​​sẽ là một JSON với tham số "queryStringParameter".
Thực hiện theo 4 bước dưới đây để đạt được điều đó:

1. Mở mẫu ánh xạ của tài nguyên API Gateway của bạn và thêm application/jsonnội dung mới :

2. Sao chép mẫu bên dưới, phân tích chuỗi truy vấn vào JSON và dán nó vào mẫu ánh xạ:
   

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

3. Trong API Gateway, hãy gọi hàm Lambda của bạn và thêm chuỗi truy vấn sau (ví dụ): param1=111&param2=222&param3=333

4. Mẫu ánh xạ sẽ tạo đầu ra JSON bên dưới, đây là đầu vào cho hàm Lambda của bạn.

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

5. Bạn đã hoàn tất. Từ thời điểm này, logic của hàm Lambda của bạn có thể sử dụng các tham số chuỗi truy vấn.
   Chúc may mắn!

Bạn có thể sử dụng Lambda làm "Tích hợp proxy Lambda" , tham khảo [ 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] , các tùy chọn có sẵn cho lambda này là

Đối với Nodejs Lambda 'event.headers', 'event.pathParameter', 'event.body', 'event.stageVariables' và 'event.requestContext'

Đối với sự kiện Python Lambda ['tiêu đề'] ['tên người dùng'], v.v.

Tham khảo tài liệu: https://docs.aws.amazon.com/apigateway/latest/developerguide/integrating-api-with-aws-service-lambda.html#api-as-lambda-proxy-expose-get-method-with -path-tham số để gọi-lambda-chức năng

Bạn cần sửa đổi Bản đồ

Sau khi đọc một vài trong số những câu trả lời này, tôi đã sử dụng kết hợp nhiều câu trả lời vào tháng 8 năm 2018 để lấy thông số chuỗi truy vấn thông qua lambda cho python 3.6.

Đầu tiên, tôi đã đi đến API Gateway -> API của tôi -> tài nguyên (ở bên trái) -> Yêu cầu tích hợp. Ở phía dưới, chọn Bản đồ mẫu sau đó nhập loại nội dung application/json.

Tiếp theo, chọn mẫu Truyền yêu cầu phương thức mà Amazon cung cấp và chọn lưu và triển khai API của bạn.

Sau đó, lambda event['params']là cách bạn truy cập tất cả các tham số của bạn. Đối với chuỗi truy vấn:event['params']['querystring']