webutil

Documentation

Index

• Constants
• func Chain(h http.Handler, m ...Middleware) http.Handler
• func ParseURL(t *testing.T, tsURL string) (string, int)
• func WriteJSON(w http.ResponseWriter, i interface{})
• type Middleware
  • func KeyGuard(keys []string) Middleware

Constants

const (
	HeaderAPIKey = "X-modprox-api-key"
)

Functions

func Chain

func Chain(h http.Handler, m ...Middleware) http.Handler

Chain recursively chains middleware together.

func ParseURL

func ParseURL(t *testing.T, tsURL string) (string, int)

ParseURL parses tsURL, triggering a failure on t if it is not possible to do so.

func WriteJSON

func WriteJSON(w http.ResponseWriter, i interface{})

Write the given struct as JSON into w.

Types

type Middleware

type Middleware func(http.Handler) http.Handler

A Middleware is used to execute intermediate Handlers in response to a request.

func KeyGuard

func KeyGuard(keys []string) Middleware

KeyGuard creates a Middleware which protects access to a handler by first checking for the X-modprox-api-key header being set. If at least one of the values for the header matches one of the keys configured for the KeyGuard, the handler is executed for the request. Otherwise, a StatusForbidden response is returned.