middleware

Documentation

Index

• func APIKeyHeader(header string, allow AuthFunc) func(http.Handler) http.Handler
• func APIKeyQuery(name string, allow AuthFunc) func(http.Handler) http.Handler
• func BearerToken(allow AuthFunc) func(http.Handler) http.Handler
• func BodyLimit(limit int64) func(http.Handler) http.Handler
• func CORS(config CORSConfig) func(http.Handler) http.Handler
• func Recover() func(http.Handler) http.Handler
• func RequestID() func(http.Handler) http.Handler
• func RequestIDFromContext(ctx context.Context) string
• func SecureHeaders() func(http.Handler) http.Handler
• func Timeout(duration time.Duration) func(http.Handler) http.Handler
• type AuthFunc
• type CORSConfig

Functions

func APIKeyHeader

func APIKeyHeader(header string, allow AuthFunc) func(http.Handler) http.Handler

APIKeyHeader requires a valid API key in a header.

func APIKeyQuery

func APIKeyQuery(name string, allow AuthFunc) func(http.Handler) http.Handler

APIKeyQuery requires a valid API key in a query parameter.

func BearerToken

func BearerToken(allow AuthFunc) func(http.Handler) http.Handler

BearerToken requires a valid Authorization: Bearer token.

func BodyLimit

func BodyLimit(limit int64) func(http.Handler) http.Handler

BodyLimit caps the size of incoming request bodies.

func CORS

func CORS(config CORSConfig) func(http.Handler) http.Handler

CORS adds a small dependency-free CORS middleware.

func Recover

func Recover() func(http.Handler) http.Handler

Recover converts panics into RFC 9457 Problem Details responses.

func RequestID

func RequestID() func(http.Handler) http.Handler

RequestID ensures each request has an X-Request-ID header and context value.

func RequestIDFromContext

func RequestIDFromContext(ctx context.Context) string

RequestIDFromContext returns the request ID set by RequestID.

func SecureHeaders

func SecureHeaders() func(http.Handler) http.Handler

SecureHeaders adds conservative browser security headers.

func Timeout

func Timeout(duration time.Duration) func(http.Handler) http.Handler

Timeout limits the time a handler may spend serving a request.

Types

type AuthFunc

type AuthFunc func(string) bool

type CORSConfig

type CORSConfig struct {
	AllowedOrigins []string
	AllowedMethods []string
	AllowedHeaders []string
}