wulfmann / auto-cdk Goto Github PK

Effortless APIs with CDK

JavaScript 3.84% TypeScript 96.16%

cdk api generator aws aws-lambda api-gateway webpack

auto-cdk's Introduction

Auto CDK

auto-cdk lets you generate an api gateway with lambda integrations based on the filesystem. It makes use of AWS CDK to generate cloudformation stacks, and Webpack for bundling and code-splitting.

Caveats

Currently this project only aims to build and package node/typescript-based integrations. It is on the roadmap to support more, but will not be available until a later version.

Quickstart

yarn add auto-cdk

Create an api directory and add a file to it that exports a function named handler:

$ mkdir api && touch api/index.ts

// api/index.ts

exports.handler = (event, ctx) => {
  return {
    statusCode: 200,
    body: 'hello world',
    headers: {
      'Content-Type': 'text/html'
    }
  }
}

Run:

$ yarn dev

You should now have webpack auto-compiling when your source changes, and a cdk stack that has been generated in cdk.out.

Bonus

If you install AWS sam-cli, you can run the api on localhost with the following:

$ sam local start-api cdk.out/*.template.json

View more examples here.

Features

Automatic CDK Stack Generation
Code-Splitting and Bundling with Webpack
Out of the box typescript support

Contributing

If you would like to make a contribution or learn more about running this project locally, please review the Contributing Documentation.

auto-cdk's People

Contributors

Stargazers

Watchers

Forkers

jitendriyag2 squeezetoyaliens

auto-cdk's Issues

Accept open api spec

Add dev mode to enable hot reloading

When using sam-cli, the api will watch the asset directory to enable hot reload. In our case the asset directory is dist.

We need to create a dev webpack config that will auto-compile the source so that the live reload works.

Add support for models and validators

A user should be able to cause a request model and validator to be created by exporting a schema object from the handler.

Allow user to attach api gateway policies

This is set when the restapi is created

We could implement this with a policy.ts file at the root

Allow global Cors option

Allow user to modify resource configuration

Currently when the generator encounters a directory, it creates a new api resource with the directory name and a default configuration.

The user may want to modify this configuration.

The proposed solution to this is to specify a config file that will not be mapped to a handler, but instead pulled in at resource creation time and passed in.

Tweak webpack optimizations to enable tree shaking

Allow user to pass environment variables to handlers

Improve Test Coverage

Allow user to modify webpack config

Add auto-database option

Add option to include a database in the default stack and pass the name as an env var to all handlers and assign relevant permissions to each handler.

Allow individual handler configuration

We want the users to be able to specify integration-specific configuration.

One way we could accomplish this is by allowing handlers to export a variable with configuration options.

Allow user to specify response templates

Add more complex examples

Support other integration types than node

We could support other handler types as long as they were nested in a directory ie user/main.py

Add support for authorizers

Unsure how we would implement this.

One idea is making authorizer a protected filename. Any file somedir/authorizer.ts would be mapped to an authorizer being created on the somedir resource.

Another option is to export an authorizer function from a handler.

Refactor to something like resourceFromPath

It may be worth refactoring some of the recursion you’re follow something like cdk does:

https://github.com/aws/aws-cdk/blob/f44ae607670bccee21dfd390effa7d0e8701efd4/packages/%40aws-cdk/aws-apigateway/lib/resource.ts#L328

The reason we wouldn’t use this method outright is because it forces you to use the default resource options. We could simply refactor our looping to be similar, but with options.