Skip to content

Latest commit

 

History

History
133 lines (110 loc) · 4.88 KB

README.md

File metadata and controls

133 lines (110 loc) · 4.88 KB
Raw

Serverless Swagger Plugin

NOTE: This plugin is currently under development

serverless

A Serverless v1.0 plugin for AWS that generates swagger.yaml for API Gateway (APIG) lambda proxy and uses AWS APIs to deploy/update HTTP evented Lambdas.

Why?

Serverless currently maintains API Gateway and Lambda via Cloudformation. This does not work for us because:

CloudFormation (CF):

  • CloudFormation has item limits
  • It is not a security best practice to allow deletion of assets from an AWS API Key (can't back with MFA)
  • CloudFormation is very powerful. We like to visually validate (via diff and CF web UI diff function) exactly what is going to change.
  • Serverless deletes and re-creates APIG distro on every update
  • CloudFormation is not good for frequently changing assets because it sometimes gets into a rollback failed state. You must delete CF and re-create. Not fun hitting this in production
  • CloudFormation does not stay on top of new AWS features

We prefer Swagger:

  • It is an industry standard, and the "export swagger" from APIG web UI creates ugly and complex swagger
  • We can tie a swagger file to a release. This can be referenced and imported at any time into tooling like postman
  • We manually review changes to our API Gateway before deploying to different stages

Install

From your serverless project run:

npm install serverless-plugin-swag --save-dev

Add the plugin to your serverless.yml file:

plugins:
  - serverless-plugin-swag

Configure

This plugin minimal configuration under the custom.swag namespace. Only 2 elments in your serverless.yml are required:

  1. custom.swag.restApiId: the API Gateway distribution ID.
  2. A swagHttp (instead of http) entry in functions.FUNCTION_NAME.events. Currently, the only 2 attributes supported are path and method.

This plugin requires that the lambda code artifact already exist (or be build outside of this plugin). I highly recommend my browserify plugin but you can also manually define functions.FUNCTION.package.artifact (see artifacts).

see example serverless.yml

Usage

TODO:

  • Be able to create/update functions via glob syntax. Ex: sls swag deployFunc pages*
  • Create/update list of functions. Ex: sls swag deployFunc pageGet pageUpdate
  • Create/update entire APIG distro
  • Create/update one APIG resource
  • Support events.swagHttp.authorizer and events.swagHttp.
  • Do I need to supporot a

FAQ

  • Why Swagger as JSON instead of YAML? Because AWS only supports importing swagger as JSON :(

Tmp Backup for me

---
swagger: "2.0"
info:
  version: "2016-09-22T21:51:08Z"
  title: "ryan-proxy-test"
host: "myuid.execute-api.us-east-1.amazonaws.com"
basePath: "/yrdy"
schemes:
- "https"
paths:
  /{proxy+}:
    options:
      consumes:
      - "application/json"
      produces:
      - "application/json"
      responses:
        200:
          description: "200 response"
          schema:
            $ref: "#/definitions/Empty"
          headers:
            Access-Control-Allow-Origin:
              type: "string"
            Access-Control-Allow-Methods:
              type: "string"
            Access-Control-Allow-Headers:
              type: "string"
      x-amazon-apigateway-integration:
        responses:
          default:
            statusCode: "200"
            responseParameters:
              method.response.header.Access-Control-Allow-Methods: "'DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT'"
              method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization,X-Amz-Date,X-Api-Key,X-Amz-Security-Token'"
              method.response.header.Access-Control-Allow-Origin: "'*'"
        requestTemplates:
          application/json: "{\"statusCode\": 200}"
        passthroughBehavior: "when_no_match"
        type: "mock"
    x-amazon-apigateway-any-method:
      produces:
      - "application/json"
      parameters:
      - name: "proxy"
        in: "path"
        required: true
        type: "string"
      responses: {}
      x-amazon-apigateway-integration:
        responses:
          default:
            statusCode: "200"
        uri: "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:myAWSAccount:function:helloworld-proxy/invocations"
        passthroughBehavior: "when_no_match"
        httpMethod: "POST"
        cacheNamespace: "1rnijn"
        cacheKeyParameters:
        - "method.request.path.proxy"
        type: "aws_proxy"
definitions:
  Empty:
    type: "object"
    title: "Empty Schema"