aws-gateway-api

AWS Gateway API Client

You might ask why does this exist? Well there are a few other tools out there but most of them seem to not be up to date or come with some huge library like JAWS or Fluct. I just wanted a simple wrapper that I could use to programmability setup an API however I want. Enjoy!

Usage

The basic usage is just new up a new object passing settings and you will be able to get all info from that object with functions and callbacks.

npm install aws-gateway-api --save

var Gateway = require('aws-gateway-api');
 
var api = new Gateway({
  accessKeyId: [AWS users access key (Defaults to environment variable AWS_ACCESS_KEY_ID)],
  secretAccessKey: [AWS users secret access key (Defaults to environment variable AWS_SECRET_ACCESS_KEY)]
  region: [AWS region (Defaults to environment variable AWS_REGION)]
});
 
//Now you can get a restApi like so
api.getRestApi('3ffr3r3r', function(err, restApi) {
  if (err) {
    console.log(err);
  } else {
    console.log(restApi.name);
  }
});

I am working on the documentation for all the methods now.

Testing

If you want to run the tests on this project you will need to set 4 environment variables so pointing to AWS. The user who has access key you use must have full permissions to the AWS Gateway API but will clean up everything after running. I tend to add these to my .bashrc or .bash_profile file.

export AWS_ACCESS_KEY_ID="[YOUR ACCESS KEY ID]"
export AWS_SECRET_ACCESS_KEY="[YOUR ACCESS KEY SECRET]"
export AWS_REGION="[THE AWS REGION]"
export AWS_ACCOUNT_ID="[YOUR AWS ACCOUNT ID]"