登录
首页 >  Golang >  Go问答

找不到 Golang 的 API 网关映射模板

来源:stackoverflow

时间:2024-03-21 12:00:40 442浏览 收藏

在 AWS API 网关上创建 webhook 时,需要映射模板来将请求正文转换为 Lambda 函数可用的格式。然而,对于使用 application/x-www-form-urlencoded 内容类型的 Go 语言 Lambda 函数,找不到合适的映射模板。本文档介绍了 API 网关映射模板的工作原理,并探讨了为何当前模板无法正确映射请求正文。此外,它提供了有关 Lambda 代理集成处理程序签名的信息,以及何时使用代理集成而不是 Lambda 集成的注意事项。

问题内容

我在 aws api gateway 上为 twilio 创建了一个 webhook,它以 application/x-www-form-urlencoded content-type 发送请求。我无法编写或找到 golang 的映射模板。 我正在关注此文档 - 用于创建 api 网关的链接。我目前正在使用文档中使用的以下模板 -

我正在使用的 api gateway 映射模板:

#set($httppost = $input.path('$').split("&"))
{
#foreach( $kvpair in $httppost )
 #set($kvtokenised = $kvpair.split("="))
 #if( $kvtokenised.size() > 1 )
   "$kvtokenised[0]" : "$kvtokenised[1]"#if( $foreach.hasnext ),#end
 #else
   "$kvtokenised[0]" : ""#if( $foreach.hasnext ),#end
 #end
#end
}

api gateway 映射模板创建的 json:

{
    "tocountry": "us",
    "tostate": "ut",
    "smsmessagesid": "smed65aaxxxxxx5c7938df",
    "nummedia": "0",
    "tocity": "",
    "fromzip": "",
    "smssid": "smed65aaxxxxxx938df",
    "fromstate": "",
    "smsstatus": "received",
    "fromcity": "",
    "body": "testing+again",
    "fromcountry": "in",
    "to": "%2b1xxxxxx848",
    "tozip": "",
    "numsegments": "1",
    "messagesid": "smed65aa5dxxxx7938df",
    "accountsid": "ac23xxxd98",
    "from": "%2b9xxxxxx90",
    "apiversion": "2010-04-01"
}

lambda 代码(golang)

func handler(request events.apigatewayproxyrequest) (events.apigatewayproxyresponse, error) {

    fmt.printf("%+v\n", request)
    fmt.println("request body:", request.body)
    fmt.println("request httpmethod:", request.httpmethod)
    fmt.println("request headers:", request.headers)
    fmt.println("request:", request.requestcontext.requestid)
}

api网关日志

(442f74ed-39e5-4372-bf85-42bf814f802f) extended request id: eiayxxmf3lq=
(442f74ed-39e5-4372-bf85-42bf814f802f) method request path: {}

(442f74ed-39e5-4372-bf85-42bf814f802f) method request query string:    {}

(442f74ed-39e5-4372-bf85-42bf814f802f) method request headers: {accept=*/*, cache-control=max-age=259200, x-twilio-signature=zwg2v7xxxfnblpyxe=, user-agent=twilioproxy/1.1, x-forwarded-proto=https, i-twilio-idempotency-token=e5d1xxx221bc4, x-forwarded-for=54.xxxx.227, host=xxxxxxx.execute-api.us-east-1.amazonaws.com, x-forwarded-port=443, x-amzn-trace-id=root=1-5de67103-7994dbxxx0dbd872, content-type=application/x-www-form-urlencoded}}  

(442f74ed-39e5-4372-bf85-42bf814f802f) method request body before transformations: tocountry=us&tostate=ut&smsmessagesid=smed65axxx595c7938df&nummedia=0&tocity=&fromzip=&smssid=smed65aa5xxccdd595c7938df&fromstate=&smsstatus=received&fromcity=&body=good+day&fromcountry=in&to=%2bxxxx848&tozip=&numsegments=1&messagesid=smed65axxxd595c7938df&accountsid=ac23a2cbxxx65a66d98&from=%2b9xxxx5590&apiversion=2010-04-01

(442f74ed-39e5-4372-bf85-42bf814f802f) endpoint request uri: https://lambda.us-east-1.amazonaws.com/2015-03-31/functions/arn:aws:lambda:us-east-1:6xxxxxxxx6:function:twillio_connector_test/invocations

(442f74ed-39e5-4372-bf85-42bf814f802f) endpoint request headers: {x-amzn-lambda-integration-tag=442f74ed-39e5-4372-bf85-42bf814f802f, authorization=*****27aa7a, x-amz-date=20191203t142819z, x-amzn-apigateway-api-id=xxxxx, x-amz-source-arn=arn:aws:execute-api:us-east-1:69xxxx886:xxxxxxx/v1/post/message, accept=application/x-www-form-urlencoded, user-agent=amazonapigateway_f7504e7yc6, x-amz-security-token=iqojbxxxhqh [truncated]

(442f74ed-39e5-4372-bf85-42bf814f802f) endpoint request body after transformations: 
    {
        "tocountry": "us",
        "tostate": "ut",
        "smsmessagesid": "smed65aaxxxxxx5c7938df",
        "nummedia": "0",
        "tocity": "",
        "fromzip": "",
        "smssid": "smed65aaxxxxxx938df",
        "fromstate": "",
        "smsstatus": "received",
        "fromcity": "",
        "body": "good+day",
        "fromcountry": "in",
        "to": "%2b1xxxxxx848",
        "tozip": "",
        "numsegments": "1",
        "messagesid": "smed65aa5dxxxx7938df",
        "accountsid": "ac23xxxd98",
        "from": "%2b9xxxxxx90",
        "apiversion": "2010-04-01"
    }

(442f74ed-39e5-4372-bf85-42bf814f802f) endpoint response headers: {date=tue, 03 dec 2019 14:28:20 gmt, content-type=application/json, content-length=43, connection=keep-alive, x-amzn-requestid=168394b7-c152-4434-af02-03a03b6f3090, x-amzn-remapped-content-length=0, x-amz-executed-version=$latest, x-amzn-trace-id=root=1-5de67103-7994dbxxxxbe30dbd872;sampled=0}

(442f74ed-39e5-4372-bf85-42bf814f802f) endpoint response body before transformations: "lambda function is completed successfully"

(442f74ed-39e5-4372-bf85-42bf814f802f) method response body after transformations: lambda function is completed successfully

(442f74ed-39e5-4372-bf85-42bf814f802f) method response headers: {x-amzn-trace-id=root=1-5de67103-7994dbxxxxxxd872;sampled=0, content-type=application/xml}

lambda 函数日志

request: {   map[] map[] map[] map[] map[] map[] {    {           }  map[]  } good day false}
{resource: path: httpmethod: headers:map[] multivalueheaders:map[] querystringparameters:map[] multivaluequerystringparameters:map[] pathparameters:map[] stagevariables:map[] requestcontext:{accountid: resourceid: stage: requestid: identity:{cognitoidentitypoolid: accountid: cognitoidentityid: caller: apikey: accesskey: sourceip: cognitoauthenticationtype: cognitoauthenticationprovider: userarn: useragent: user:} resourcepath: authorizer:map[] httpmethod: apiid:} body:good day isbase64encoded:false}
request body: good day
request httpmethod: 
request headers: map[]

在 lambda 日志中,我可以看到只有创建的 json 正文被映射到 events.apigatewayproxyrequest 而不是其他参数。 原因是映射模板创建的 json 不是以下格式 -

The events.APIGatewayProxyRequest parameter in golang:
// APIGatewayProxyRequest contains data coming from the API Gateway proxy

type APIGatewayProxyRequest struct {
    Resource                        string                        `json:"resource"` // The resource path defined in API Gateway
    Path                            string                        `json:"path"`     // The url path for the caller
    HTTPMethod                      string                        `json:"httpMethod"`
    Headers                         map[string]string             `json:"headers"`
    MultiValueHeaders               map[string][]string           `json:"multiValueHeaders"`
    QueryStringParameters           map[string]string             `json:"queryStringParameters"`
    MultiValueQueryStringParameters map[string][]string           `json:"multiValueQueryStringParameters"`
    PathParameters                  map[string]string             `json:"pathParameters"`
    StageVariables                  map[string]string             `json:"stageVariables"`
    RequestContext                  APIGatewayProxyRequestContext `json:"requestContext"`
    Body                            string                        `json:"body"`
    IsBase64Encoded                 bool                          `json:"isBase64Encoded,omitempty"`
}

如果有人能向我指出相关文档,我将不胜感激。欢迎提出建议。


解决方案


您可能正在尝试使用代理集成处理程序签名来处理特定资源上的 lambda 自定义集成事件。我不认为映射模板与代理集成相关。

lambda 集成

使用 lambda 响应 api gateway 请求的方式主要有两种。第一种是使用 Lambda integration。此方法通常涉及将请求转换为自定义 lambda 事件,完全由您自行决定。大部分繁重的工作都是由 api gateway 完成的。例如,您可以将查询参数转换为字符串,然后将该字符串提供给您的 lambda 处理程序。

func handler(e string) (, error) {}

或者,您可以从标头中获取值并从 url 中获取一部分,然后构建一个 json 对象以提供给您的处理程序。

type event struct {
    urlpart string `json:"url_part"`
    querypart string `json:"query_part"`
}

func handler(e *event) (, error) {}

要点

  • 您可以完全控制到达您的函数的请求事件
  • 您可以完全控制 lambda 返回的响应
  • 更多繁重的工作由 api 网关完成

代理集成

然后是 Proxy Integration。代理集成会将发送到您在 api 网关中指定的资源(通常是 {proxy+} 资源上的任何方法)的每个请求转换为 events.apigatewayproxyrequest 结构类型在事件模块中定义。这消除了您将请求转换为必须指定的特定事件的需要,并从 api gateway 中删除了请求的繁重工作,并将其放入您的 lambda 处理程序中。

代理集成处理程序必须具有以下签名:

func handler(c context.Context, e events.APIGatewayProxyRequest) (events.APIGatewayProxyResponse, error) {}

要点

  • 请求和响应始终相同,events.apigatewayproxyrequest 和 events.apigatewayproxyresponse
  • api gateway 中需要完成的工作少得多
  • 通常在您已经对 golang 解决方案投入大量资金并且不想将其分解为 lambda 集成的单独资源块时使用。

这里是 link that explains more of the differences 以及每个号码的一些注意事项。

今天带大家了解了的相关知识,希望对你有所帮助;关于Golang的技术知识我们会一点点深入介绍,欢迎大家关注golang学习网公众号,一起学习编程~

声明:本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>