API Gateway request/response models

marjanSterjev · September 11, 2016, 6:22am

It would be nice if we can specify API Gateway request/response models in the serverless.yml. Client code generation feature in the AWS API Gateway Console depends on the request/response models
specified.

Is this possible in the latest release, i.e. 1.0.0-rcx? There are some plugins out there, but they are compatible with the 0.5.x version of Serverless.

Thx

mjzone · September 11, 2016, 12:36pm

According to the documentation 01-apigateway.md You should be able to define default/custom request/response templates. But I came across an issue when trying their example code,
functions: create: handler: posts.create events: - http: method: get path: whatever request: template: application/json: { "httpMethod" : "$context.httpMethod" }
This fails at deployment.

marjanSterjev · September 11, 2016, 3:46pm

Hi,
It seems Request/Response templates are Velocity templates that transform HTTP request into Integration request (i.e. Lambda event) and Lamda integration response into HTTP method response.

On the contrary, models are attached on the “left”, client facing side in the AWS Api Gateway Console authoring dashboard.

BR

jonsharratt · September 11, 2016, 4:19pm

I had this issue recently, I first wrapped it within single quote marks which fixed it but have found the nicest way that is currently supported is to do a multi line YAML string.

Example:

github.com

craftship/codebox-npm/blob/master/serverless.yml

frameworkVersion: '>=1.20.2'

plugins:
  - environment-variables
  - remove-storage
  - serverless-webpack
  - content-handling
  - codebox-tools
  - set-api-host

service: codebox-npm

provider:
  name: aws
  runtime: nodejs6.10
  stage: ${opt:stage}
  region: ${env:CODEBOX_REGION}
  environment:
    admins: ${env:CODEBOX_ADMINS}
    restrictedOrgs: ${env:CODEBOX_RESTRICTED_ORGS}

This file has been truncated. show original

Hope this helps @mjzone

Jon

mjzone · September 11, 2016, 4:46pm

Super! it works like a charm. Thanks Jon. @jonsharratt

mjzone · September 11, 2016, 5:02pm

That’s right @marjanSterjev. I mixed up templates/models.

flomotlik · September 17, 2016, 1:53pm

FYI we’re also currently working on a new feature for this that will make this a lot easier and mostly unnecessary due to automated matching. More to come soon.

schakkis · September 29, 2016, 3:04pm

I’m also interested in support for APIGW request/response models. I tried to just define them as CloudFormation resources, but I still need to have the mapping between the method and the model.

I saw that there was https://github.com/serverless/serverless/issues/1734, but I haven’t found any other information.

Topic		Replies	Views
Setting API Gateway Method/Integration Response/Request with Lambda Integration Serverless Framework lambda , api-gateway	10	6084	June 25, 2020
How to add API Gateway Method Responses via serverless.yml Serverless Framework aws , api-gateway	1	949	November 1, 2021
Setting response headers in the yml Serverless Framework	0	1304	July 22, 2021
API Gateway schema Serverless Framework api-gateway	0	822	September 21, 2018
How to create a Mock API Gateway endpoint Serverless Framework aws	0	3203	June 19, 2017

API Gateway request/response models

Related topics