Terrable

"What if there was something that helped me write and deploy terraformed API Gateways and run them locally?"

"That sounds like a terrable idea"

---

Terrable is a CLI tool that works seamlessly with its companion Terraform module to simplify building, testing and deploying AWS API Gateways.

Features

• Easy configuration of API Gateways using Terraform
• Local development and testing of API endpoints
• Seamless deployment to AWS
• TypeScript support for handler functions

Installation

Install Terrable using Go:

go install github.com/terrable-dev/terrable@latest

Quick Start

1. Use the Terrable Terraform module in your configuration:

module "example_api" {
  source = "terrable-dev/terrable-api/aws"
  version = "0.0.1"
  api_name = "example-api"
  
  handlers = {
    ExampleHandler: {
        source = "./ExampleHandler.ts"
        http = {
          method = "GET"
          path = "/"
        }
    },
  }
}

2. Run your API locally using the Terrable CLI:

terrable -file terraform_file.tf -module example_api