Serverless Swagger API

This is a serverless plugin that simplifies the process of creating an AWS API Gateway from a swagger file.

Installation

yarn add --dev serverless-swagger-api

Configuration

Lambda Functions

You must manually create your own lambda functions in the serverless configuration. Once the methods are created, they will be referenced in the swagger file.

Swagger File

Add a x-lambda-name property to every path method to bind a part of the api to a lambda. Values specified for x-lambda-name is AWS CloudFormation resource names, i.e., values in the form of {normalizedFunctionName}LambdaFunction. For more information about naming rules, please refer to the description in the Serverless Framework documentation.

paths:
  /testPath:
    get:
      x-lambda-name: TestPathLambdaFunction
      ...

CORS Configuration

Add a x-cors property to the path you want to add CORS options responses to.

paths:
  /testPath:
    x-cors: true

If you want to specify a specific attribute, provide one of the following properties

Plugin Settings

Now you need to tell the swagger api plugin about your configuration file. Add a swaggerApi property to the custom section of your serverless configuration. You can add as many apis as you want by adding children to the swaggerApi.apis property.

updateDeployments

Will automatically update API gateway deployments if not set to false.

usePackageVersion

The info.version value in your OpenAPI file will be overwritten with the version in package.json.

apis

An object containing all of the APIs to be defined in this stack.

custom:
  swaggerApi:
    updateDeployments: true
    usePackageVersion: true
    apis:
      PrimaryApi:
        Name: ${self:provider.stage}-${self:service}-PrimaryApi
        Body: ${file(./some-swagger-file.yaml)}
        Lambda: ExampleLambdaFunction
        Stage: dev

Properties

Each API object has the following properties

Created Resources

IAM Roles

An IAM role is created for each API with the name PrimaryApiServiceRole

License