middleware

Documentation

Index

• func Error(w http.ResponseWriter, status int)
• func Logged(h func(w http.ResponseWriter, r *http.Request)) http.Handler
• func WithOptions(h http.HandlerFunc, options HandlerOptions) http.Handler
• type AuthenticationOptions
• type CorsOptions
• type HandlerOptions

Functions

func Error

func Error(w http.ResponseWriter, status int)

Error is a shorthand for writing standard error messages to the response writer

func Logged

func Logged(h func(w http.ResponseWriter, r *http.Request)) http.Handler

Logged logs the details of the request and response

func WithOptions

func WithOptions(h http.HandlerFunc, options HandlerOptions) http.Handler

Types

type AuthenticationOptions

type AuthenticationOptions struct {
	Required bool
	// ValidationFunc should return true or false based on whether the request is authenticated
	ValidationFunc func(*http.Request) bool
}

type CorsOptions

type CorsOptions struct {
	Enabled      bool
	AllowHeaders []string
	AllowOrigins []string
	AllowMethods []string
}

type HandlerOptions

type HandlerOptions struct {
	Methods        []string
	Cors           CorsOptions
	Authentication AuthenticationOptions
}