grunt-aws-swaggerimport

Grunt plugin to configure AWS API Gateway via a Swagger config and configure lambda permissions for API gateway.

Originally seeded from: grunt-aws-apigateway

Features

• Imports a Swagger config into an AWS API Gateway
• Can either load as a newly created API, or update an existing one.
• Can either be loaded from a file, or imported inline from a Javascript object
• Can deploy the API to a stage, including setting stage variables.

Getting Started

This plugin requires Grunt.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-aws-swaggerimport --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-aws-swaggerimport');

The "import_swagger" task

Overview

In your project's Gruntfile, add a section named import_swagger to the data object passed into grunt.initConfig().

grunt.initConfig({
  import_swagger: {
    options: {
      accessKeyId: 'your-aws-access-key-id',
      secretAccessKey: 'your-aws-secret-access-key',
      region: 'your-aws-region',
      assumeRole: {}, // OPTIONAL
    },
    your_target: {
      // REQUIRED: Either String or Object.
      swagger_config: 'path/to/your/swagger-file.json',

      // OPTIONAL
      update: {
        restApiId: 'id-of-api-to-update'
        mode: 'overwrite', // May be either merge or overwrite.
      },

      // OPTIONAL
      deployment: {
        stageName: 'my-stage',
        cacheClusterEnabled: false,
        description: 'My deployment ' + Date.now(),
        stageDescription: 'My stage description',
        variables: {
          someStageVariable: 'some-stage-variable',
        }
      },
    },
  },
})

Options

options.accessKeyId

Type: String

AWS Access Key Id with which to import the API

options.secretAccessKey

Type: String

AWS Secret Access Key Id with which to import the API

options.region

Type: String

AWS region in which to import the API

options.assumeRole

Type: String

Optional. Hash of params to deploy the API by assuming a role. See the AWS assumeRole docs for info on the parameters to provide here.

var params = {
  RoleArn: 'STRING_VALUE', /* required */
  RoleSessionName: 'STRING_VALUE', /* required */
  DurationSeconds: 0,
  ExternalId: 'STRING_VALUE',
  Policy: 'STRING_VALUE',
  SerialNumber: 'STRING_VALUE',
  TokenCode: 'STRING_VALUE'
};

Target parameters

target.swagger_config

Type: String OR Object

Required. Can either be a (string) path to swagger json file, or inline object. Using an inline object means it can be dynamically constructed. // swagger_config: {/* ... config as object ... */}

target.update

Type: Object

Optional. Include the update block if you want to update an existing API A new API will be created if no update block is provided.

target.deployment

Type: Object

Optional. Include the deployment block if you want to deploy the API to a stage. See the AWS createDeployment docs for info on these parameters (note: restApiId is taken from the swagger import result and cannot be specified in these deployment params).

{
  stageName: 'STRING_VALUE', /* required */
  cacheClusterEnabled: true || false,
  cacheClusterSize: '0.5 | 1.6 | 6.1 | 13.5 | 28.4 | 58.2 | 118 | 237',
  description: 'STRING_VALUE',
  stageDescription: 'STRING_VALUE',
  variables: {
    someKey: 'STRING_VALUE',
    /* anotherKey: ... */
  }
}

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

1.1.0

Added the ability to provide an AWS IAM role to assume, with which to deploy the API.

1.0.1

Update to contact email

1.0.0

Initial release.

• Handles import via file or inline.
• Ability to either create new or update existing api.
• Ability to deploy to a stage.

License

Copyright (c) 2016 Simple Merchant. Licensed under the MIT license.