gateway

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(":3000", nil))

Index

• func ListenAndServe(addr string, h http.Handler) error
• func NewRequest(ctx context.Context, e events.APIGatewayV2HTTPRequest) (*http.Request, error)
• func RequestContext(ctx context.Context) (events.APIGatewayV2HTTPRequestContext, bool)
• type Gateway
  • func NewGateway(h http.Handler) *Gateway
  • func (gw *Gateway) Invoke(ctx context.Context, payload []byte) ([]byte, error)
• type ResponseWriter
  • func NewResponse() *ResponseWriter
  • func (w *ResponseWriter) CloseNotify() <-chan bool
  • func (w *ResponseWriter) End() events.APIGatewayV2HTTPResponse
  • 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.APIGatewayV2HTTPRequest) (*http.Request, error)

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

func RequestContext

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

RequestContext returns the APIGatewayV2HTTPRequestContext value stored in ctx.

Types

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, payload []byte) ([]byte, error)

Invoke Handler implementation

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.APIGatewayV2HTTPResponse

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.