gateway

README

Gateway

Package gateway provides a drop-in replacement for net/http's ListenAndServe for use in AWS Lambda & API Gateway, simply swap it out for gateway.ListenAndServe. Extracted from Up which provides additional middleware features and operational functionality.

There are two versions of this library, version 1.x supports AWS API Gateway 1.0 events used by the original REST APIs, and 2.x which supports 2.0 events used by the HTTP APIs. For more information on the options read Choosing between HTTP APIs and REST APIs on the AWS documentation website.

Installation

To install version 1.x for REST APIs.

go get github.com/Drafteame/gateway/v2

Example

package main

import (
	"fmt"
	"log"
	"net/http"
	"os"

	"github.com/Drafteame/gateway/v2"
)

func main() {
	http.HandleFunc("/", hello)
	log.Fatal(gateway.ListenAndServe(nil))
}

func hello(w http.ResponseWriter, r *http.Request) {
	// example retrieving values from the api gateway proxy request context.
	requestContext, ok := gateway.RequestContext(r.Context())
	if !ok || requestContext.Authorizer["sub"] == nil {
		fmt.Fprint(w, "Hello World from Go")
		return
	}

	userID := requestContext.Authorizer["sub"].(string)
	fmt.Fprintf(w, "Hello %s from Go", userID)
}

Documentation

Overview

Package gateway provides a drop-in replacement for net/http.ListenAndServe for use in AWS Lambda & API Gateway.

Example

http.HandleFunc("/", hello)
log.Fatal(gateway.ListenAndServe(nil))

Index

• func ListenAndServe(h http.Handler, opts ...Option) error
• func NewRequest(ctx context.Context, e events.APIGatewayProxyRequest) (*http.Request, error)
• func RequestContext(ctx context.Context) (events.APIGatewayProxyRequestContext, bool)
• type Decorator
• type Gateway
  • func NewGateway(h http.Handler) *Gateway
  • func (gw *Gateway) Invoke(ctx context.Context, evt events.APIGatewayProxyRequest) (events.APIGatewayProxyResponse, error)
• type Option
  • func WithDecorator(d Decorator) Option
• type Options
  • func (o *Options) Apply(handler interface{}) interface{}
• type ResponseWriter
  • func NewResponse() *ResponseWriter
  • func (w *ResponseWriter) CloseNotify() <-chan bool
  • func (w *ResponseWriter) End() events.APIGatewayProxyResponse
  • func (w *ResponseWriter) Header() http.Header
  • func (w *ResponseWriter) Write(b []byte) (int, error)
  • func (w *ResponseWriter) WriteHeader(status int)

Examples

• Package

Functions

func ListenAndServe

func ListenAndServe(h http.Handler, opts ...Option) error

ListenAndServe is a drop-in replacement for http.ListenAndServe for use within AWS Lambda.

ListenAndServe always returns a non-nil error.

func NewRequest

func NewRequest(ctx context.Context, e events.APIGatewayProxyRequest) (*http.Request, error)

NewRequest returns a new http.Request from the given Lambda event.

func RequestContext

func RequestContext(ctx context.Context) (events.APIGatewayProxyRequestContext, bool)

RequestContext returns the APIGatewayProxyRequestContext value stored in ctx.

Types

type Decorator

type Decorator func(handler interface{}) interface{}

Decorator is a wrapper function that adds functionality to the current lambda handler.

type Gateway

type Gateway struct {
	// contains filtered or unexported fields
}

Gateway wrap a http handler to enable use as a lambda.Handler

func NewGateway

func NewGateway(h http.Handler) *Gateway

NewGateway creates a gateway using the provided http.Handler enabling use in existing aws-lambda-go projects

func (*Gateway) Invoke

func (gw *Gateway) Invoke(ctx context.Context, evt events.APIGatewayProxyRequest) (events.APIGatewayProxyResponse, error)

type Option

type Option func(*Options)

Option is a callback that configure som handler option.

func WithDecorator

func WithDecorator(d Decorator) Option

WithDecorator adds a new decorator to the lambda handler configuration.

type Options

type Options struct {
	Decorators []Decorator
}

Options represents all options that can be applied to the lambda handler.

func (*Options) Apply

func (o *Options) Apply(handler interface{}) interface{}

Apply executes options over the lambda handler.

type ResponseWriter

type ResponseWriter struct {
	// contains filtered or unexported fields
}

ResponseWriter implements the http.ResponseWriter interface in order to support the API Gateway Lambda HTTP "protocol".

func NewResponse

func NewResponse() *ResponseWriter

NewResponse returns a new response writer to capture http output.

func (*ResponseWriter) CloseNotify

func (w *ResponseWriter) CloseNotify() <-chan bool

CloseNotify notify when the response is closed

func (*ResponseWriter) End

func (w *ResponseWriter) End() events.APIGatewayProxyResponse

End the request.

func (*ResponseWriter) Header

func (w *ResponseWriter) Header() http.Header

Header implementation.

func (*ResponseWriter) Write

func (w *ResponseWriter) Write(b []byte) (int, error)

Write implementation.

func (*ResponseWriter) WriteHeader

func (w *ResponseWriter) WriteHeader(status int)

WriteHeader implementation.