gateway

README

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.

package main

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

	"github.com/apex/gateway"
	"github.com/aws/aws-lambda-go"
)

func main() {
	http.HandleFunc("/", hello)
	log.Fatal(gateway.ListenAndServe(":3000", 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

package main

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

	"github.com/apex/gateway"
)

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

func hello(w http.ResponseWriter, r *http.Request) {
	fmt.Fprintln(w, "Hello World from Go")
}

Index

• func ListenAndServe(addr string, h http.Handler) error
• func NewRequest(ctx context.Context, e events.APIGatewayProxyRequest) (*http.Request, error)
• func RequestContext(ctx context.Context) (events.APIGatewayProxyRequestContext, bool)
• 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(addr string, h http.Handler) 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 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.