responseParameters support

[spardo]

Would like support for responseParameters.

Not sure if the example below is valid but would like to dynamically load responses to the header, such as location for a newly created item.

"responses": {
   "default": {
      "statusCode": "201",
      "responseParameters": {
         "method.response.header.Location": "integration.response.body.location"
      },
      "responseModels": {},
      "responseTemplates": {
         "application/json": "$input.path('$.body')"
      }
   }
}

[martinmicunda]

I am currently working on error API Gateway and lambda error handling and here is my use case:

"responses": {
   "default": {
      "statusCode": "200",
      "responseParameters": {},
      "responseModels": {},
      "responseTemplates": {
          "application/json": ""
      }
   },
   ".*\"statusCode\":404.*": {
      "statusCode": "404",
      "responseParameters": {},
      "responseModels": {},
      "responseTemplates": {
        "application/json": "#set($inputRoot = $input.path('$.errorMessage'))\n$inputRoot"
      }
   }
}

handler.js

context.fail(JSON.stringify({"statusCode":404,"error":"Not Found"}));

The above example works on AWS. Not sure if this on your roadmap but it would be nice if offline plugin could match regular expression and return 404 statusCode with errorMessage (currently is returning 200). This is nice article about API Gateway error handling.

[dherault]

@spardo spardo Using (request and response) parameters is hard because it really has to do with integrations, but I'll try something.

@martinmicunda You can teak you template to make it work with Offline:

   "404": {
      "statusCode": "404",
      "selectionPattern": ".*\"statusCode\":404.*",
      "responseParameters": {},
      "responseModels": {},
      "responseTemplates": {
        "application/json": "#set($inputRoot = $input.path('$.errorMessage'))\n$inputRoot"
      }
   }

But I'll commit something to make it work with your code soon.

[dherault]

@martinmicunda Solved in v1.2.2.

@spardo It seems like a long road, but request and response parameters are on their way 😅
EDIT: I'll finally wait for Serverless 0.5 before I work on that.

[martinmicunda]

I am starting to have same request like @spardo :) I try to set up response content-type to json (offline currently return conte-type as text) so it would be nice to have this feature in the offline plugin :)

  "responseParameters": {
    "method.response.header.Content-Type": "'application/json; charset=UTF-8'"
  }

[dherault]

Content-type returned as text is a bug! I'll fix it!
I've been thinking about request/responseParameters, it's possible, but will take some time.

[martinmicunda]

thanks...

[dherault]

I don't see the response content-type set as text, in which case do you have this ?

[dherault]

Anyway, I worked a fix, v1.2.6, please review it, thanks.

[martinmicunda]

sorry .. The content-type doesn't seem to be set at all... I am using Postman for testing and I have test for response content-type. Shouldn't the offline plugin send content-type="application/json; charset=UTF-8" or at least to be able somehow to configure respond..

cache-control:no-cache
Connection:keep-alive
content-length:139
Date:Tue, 15 Mar 2016 15:42:17 GMT
vary:origin,accept-encoding

[dherault]

With v1.2.6 ?

[martinmicunda]

just pulled latest version and it works ... thanks ;)

[dherault]

Sweet! I'll start working on request/responseParameters right away. Won't be before friday I think.

EDIT: @spardo @martinmicunda Only responseParameters for starters, because for requestParameters I need to hijack Hapijs's request, I'll do that later.

[dherault]

@spardo @martinmicunda So it seems that only header modification is supported by APIG's responseParameters when it comes to lambda integrations.

1.3.0 is on it's way, will support
"method.response.header.xxx": "integration.response.body"
"method.response.header.xxx": "integration.response.body.__JSONpath__"
"method.response.header.xxx": "integration.response.header.yyy"
"method.response.header.xxx": "__customHeader__"

Also, the current doc is ugly and confusing so I'll work on that.

[dherault]

@spardo @martinmicunda Done. run npm update to download the new v1.3.0.
See the new docs for usage. Happy coding!

[spardo]

Thank you very much and sorry for going dark, I was not receiving any email notifications. Can't wait to test it out.