https://github.com/jansiwy/api_gateway_dsl

Ruby DSL to generate an Amazon API Gateway definition
https://github.com/jansiwy/api_gateway_dsl

api-gateway aws dsl ruby

Last synced: 3 months ago
JSON representation

Ruby DSL to generate an Amazon API Gateway definition

• Host: GitHub
• URL: https://github.com/jansiwy/api_gateway_dsl
• Owner: jansiwy
• License: mit
• Created: 2017-03-29T12:21:30.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-04-06T20:06:05.000Z (over 9 years ago)
• Last Synced: 2025-10-11T05:03:04.219Z (9 months ago)
• Topics: api-gateway, aws, dsl, ruby
• Language: Ruby
• Size: 27.3 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/jansiwy/api_gateway_dsl.svg?branch=master)](https://travis-ci.org/jansiwy/api_gateway_dsl)

[![Code Climate](https://codeclimate.com/github/jansiwy/api_gateway_dsl/badges/gpa.svg)](https://codeclimate.com/github/jansiwy/api_gateway_dsl)

[![Test Coverage](https://codeclimate.com/github/jansiwy/api_gateway_dsl/badges/coverage.svg)](https://codeclimate.com/github/jansiwy/api_gateway_dsl/coverage)

[![Issue Count](https://codeclimate.com/github/jansiwy/api_gateway_dsl/badges/issue_count.svg)](https://codeclimate.com/github/jansiwy/api_gateway_dsl)

# Amazon API Gateway DSL

Ruby DSL to generate a [Amazon API Gateway](https://aws.amazon.com/api-gateway/) definition.

## Install

Install the Gem with

```bash

gem install api_gateway_dsl

```

## Usage

In order to generate a JSON or YAML representation of an Amazon API Gateway definition:

```bash

api_gateway_dsl json 

```

or

```bash

api_gateway_dsl yaml 

```

## Examples

There are several examples demonstrating how to specify an Amazon API Gateway definition:

* [GET Endpoint with HTTP Integration](spec/fixtures/http_get)

* [POST Endpoint with Lambda Integration](spec/fixtures/lambda_post)

* [POST Endpoint with Lambda Integration and CORS Support](spec/fixtures/lambda_post_with_cors)

* [Greedy Endpoint for any HTTP method with HTTP proxy integration](spec/fixtures/greedy_http_proxy)

* [OPTIONS Endpoint with Mock Integration](spec/fixtures/mock_options)