Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

webmiddleware

package

Go to main page

Versions in this module

v0

v0.5.2

Jun 5, 2026

v0.5.1

Jun 5, 2026

v0.5.0

Jun 5, 2026

v0.4.2

Jun 4, 2026

Changes in this version

+ const GZIPEncoding

+ var DefaultBasicAuthConfig = BasicAuthConfig

+ var DefaultBodyDumpConfig = BodyDumpConfig

+ var DefaultCORSConfig = CORSConfig

+ var DefaultCSRFConfig = CSRFConfig

+ var DefaultDecompressConfig = DecompressConfig

+ var DefaultErrorBodyDumpConfig = ErrorBodyDumpConfig

+ var DefaultGzipConfig = GzipConfig

+ var DefaultKeyAuthConfig = KeyAuthConfig

+ var DefaultMethodOverrideConfig = MethodOverrideConfig

+ var DefaultProxyConfig = ProxyConfig

+ var DefaultRateLimiterConfig = RateLimiterConfig

+ var DefaultRateLimiterMemoryStoreConfig = RateLimiterMemoryStoreConfig

+ var DefaultRecoverConfig = RecoverConfig

+ var DefaultRedirectConfig = RedirectConfig

+ var DefaultRequestIDConfig = RequestIDConfig

+ var DefaultRewriteConfig = RewriteConfig

+ var DefaultSecureConfig = SecureConfig

+ var DefaultStaticConfig = StaticConfig

+ var DefaultTimeoutConfig = TimeoutConfig

+ var DefaultTrailingSlashConfig = TrailingSlashConfig

+ var ErrRateLimitExceeded = errors.New("rate limit exceeded")

+ var ErrRateLimitIdentifier = errors.New("error while extracting identifier")

+ func AddTrailingSlash() web.Middleware

+ func AddTrailingSlashWithConfig(config TrailingSlashConfig) web.Middleware

+ func BasicAuth(fn BasicAuthValidator) web.Middleware

+ func BasicAuthWithConfig(config BasicAuthConfig) web.Middleware

+ func BodyDump(handler BodyDumpHandler) web.Middleware

+ func BodyDumpWithConfig(config BodyDumpConfig) web.Middleware

+ func BodyLimit(limit string) web.Middleware

+ func BodyLimitWithConfig(config BodyLimitConfig) web.Middleware

+ func CORS() web.Middleware

+ func CORSWithConfig(config CORSConfig) web.Middleware

+ func CSRF() web.Middleware

+ func CSRFWithConfig(config CSRFConfig) web.Middleware

+ func Compress() web.Middleware

+ func ContextTimeout(timeout time.Duration) web.Middleware

+ func ContextTimeoutWithConfig(config ContextTimeoutConfig) web.Middleware

+ func Decompress() web.Middleware

+ func DecompressWithConfig(config DecompressConfig) web.Middleware

+ func DefaultSkipper(web.Context) bool

+ func ErrorBodyDump(handler ErrorBodyDumpHandler) web.Middleware

+ func ErrorBodyDumpWithConfig(config ErrorBodyDumpConfig) web.Middleware

+ func Gzip() web.Middleware

+ func GzipWithConfig(config GzipConfig) web.Middleware

+ func HTTPSNonWWWRedirect() web.Middleware

+ func HTTPSNonWWWRedirectWithConfig(config RedirectConfig) web.Middleware

+ func HTTPSRedirect() web.Middleware

+ func HTTPSRedirectWithConfig(config RedirectConfig) web.Middleware

+ func HTTPSWWWRedirect() web.Middleware

+ func HTTPSWWWRedirectWithConfig(config RedirectConfig) web.Middleware

+ func KeyAuth(fn KeyAuthValidator) web.Middleware

+ func KeyAuthWithConfig(config KeyAuthConfig) web.Middleware

+ func MethodOverride() web.Middleware

+ func MethodOverrideWithConfig(config MethodOverrideConfig) web.Middleware

+ func NonWWWRedirect() web.Middleware

+ func NonWWWRedirectWithConfig(config RedirectConfig) web.Middleware

+ func Proxy(balancer ProxyBalancer) web.Middleware

+ func ProxyWithConfig(config ProxyConfig) web.Middleware

+ func RateLimiter(store RateLimiterStore) web.Middleware

+ func RateLimiterWithConfig(config RateLimiterConfig) web.Middleware

+ func Recover() web.Middleware

+ func RecoverWithConfig(config RecoverConfig) web.Middleware

+ func RemoveTrailingSlash() web.Middleware

+ func RemoveTrailingSlashWithConfig(config TrailingSlashConfig) web.Middleware

+ func RequestID() web.Middleware

+ func RequestIDWithConfig(config RequestIDConfig) web.Middleware

+ func RequestLoggerWithConfig(config RequestLoggerConfig) web.Middleware

+ func Rewrite(rules map[string]string) web.Middleware

+ func RewriteWithConfig(config RewriteConfig) web.Middleware

+ func Secure() web.Middleware

+ func SecureWithConfig(config SecureConfig) web.Middleware

+ func Static(root string) web.Middleware

+ func StaticWithConfig(config StaticConfig) web.Middleware

+ func Timeout() web.Middleware

+ func TimeoutWithConfig(config TimeoutConfig) web.Middleware

+ func WWWRedirect() web.Middleware

+ func WWWRedirectWithConfig(config RedirectConfig) web.Middleware

+ type BasicAuthConfig struct

+ Realm string

+ Validator BasicAuthValidator

+ type BasicAuthValidator func(string, string, web.Context) (bool, error)

+ type BodyDumpConfig struct

+ Handler BodyDumpHandler

+ Skipper Skipper

+ type BodyDumpHandler func(web.Context, []byte, []byte)

+ type BodyLimitConfig struct

+ Limit string

+ type CORSConfig struct

+ AllowCredentials bool

+ AllowHeaders []string

+ AllowMethods []string

+ AllowOriginFunc func(origin string) (bool, error)

+ AllowOrigins []string

+ ExposeHeaders []string

+ MaxAge int

+ type CSRFConfig struct

+ ContextKey string

+ CookieDomain string

+ CookieHTTPOnly bool

+ CookieMaxAge int

+ CookieName string

+ CookiePath string

+ CookieSameSite http.SameSite

+ CookieSecure bool

+ ErrorHandler CSRFErrorHandler

+ Skipper Skipper

+ TokenLength uint8

+ TokenLookup string

+ type CSRFErrorHandler func(error, web.Context) error

+ type ContextTimeoutConfig struct

+ ErrorHandler func(error, web.Context) error

+ Skipper Skipper

+ Timeout time.Duration

+ type DecompressConfig struct

+ GzipDecompressPool Decompressor

+ Skipper Skipper

+ type Decompressor interface

+ type DefaultGzipDecompressPool struct

+ type ErrKeyAuthMissing struct

+ Err error

+ func (e *ErrKeyAuthMissing) Error() string

+ func (e *ErrKeyAuthMissing) Unwrap() error

+ type ErrorBodyDumpConfig struct

+ Handler ErrorBodyDumpHandler

+ Skipper Skipper

+ type ErrorBodyDumpHandler func(web.Context, int, []byte)

+ type Extractor func(web.Context) (string, error)

+ type GzipConfig struct

+ Level int

+ MinLength int

+ Skipper Skipper

+ type KeyAuthConfig struct

+ AuthScheme string

+ ContinueOnIgnoredError bool

+ ErrorHandler KeyAuthErrorHandler

+ KeyLookup string

+ Validator KeyAuthValidator

+ type KeyAuthErrorHandler func(err error, r web.Context) error

+ type KeyAuthValidator func(auth string, r web.Context) (bool, error)

+ type MethodOverrideConfig struct

+ Getter MethodOverrideGetter

+ type MethodOverrideGetter func(web.Context) string

+ func MethodFromForm(param string) MethodOverrideGetter

+ func MethodFromHeader(header string) MethodOverrideGetter

+ func MethodFromQuery(param string) MethodOverrideGetter

+ type ProxyBalancer interface

+ AddTarget func(*ProxyTarget) bool

+ Next func(web.Context) *ProxyTarget

+ RemoveTarget func(string) bool

+ func NewRandomBalancer(targets []*ProxyTarget) ProxyBalancer

+ func NewRoundRobinBalancer(targets []*ProxyTarget) ProxyBalancer

+ type ProxyConfig struct

+ Balancer ProxyBalancer

+ ContextKey string

+ ErrorHandler func(web.Context, error) error

+ ModifyResponse func(*http.Response) error

+ RegexRewrite map[*regexp.Regexp]string

+ Rewrite map[string]string

+ Skipper Skipper

+ Transport http.RoundTripper

+ type ProxyTarget struct

+ Meta map[string]any

+ Name string

+ URL *url.URL

+ type RateLimiterConfig struct

+ DenyHandler func(web.Context, string, error) error

+ ErrorHandler func(web.Context, error) error

+ IdentifierExtractor Extractor

+ Skipper Skipper

+ Store RateLimiterStore

+ type RateLimiterMemoryStore struct

+ func NewRateLimiterMemoryStore(limit rate.Limit) *RateLimiterMemoryStore

+ func NewRateLimiterMemoryStoreWithConfig(config RateLimiterMemoryStoreConfig) *RateLimiterMemoryStore

+ func (store *RateLimiterMemoryStore) Allow(identifier string) (bool, error)

+ type RateLimiterMemoryStoreConfig struct

+ Burst int

+ ExpiresIn time.Duration

+ Rate rate.Limit

+ type RateLimiterStore interface

+ Allow func(identifier string) (bool, error)

+ type RecoverConfig struct

+ DisableErrorHandler bool

+ DisableStack bool

+ HandleError func(web.Context, error, []byte) error

+ StackSize int

+ type RedirectConfig struct

+ Code int

+ type RequestIDConfig struct

+ ContextKey string

+ Generator func() string

+ RequestIDHandler func(web.Context, string)

+ TargetHeader string

+ type RequestLoggerConfig struct

+ LogValuesFunc func(web.Context, RequestLoggerValues) error

+ type RequestLoggerValues struct

+ Error error

+ Latency time.Duration

+ Method string

+ Status int

+ URI string

+ type RewriteConfig struct

+ RegexRules map[*regexp.Regexp]string

+ Rules map[string]string

+ type SecureConfig struct

+ CSPReportOnly bool

+ ContentSecurityPolicy string

+ ContentTypeNosniff string

+ HSTSExcludeSubdomains bool

+ HSTSMaxAge int

+ HSTSPreloadEnabled bool

+ ReferrerPolicy string

+ Skipper Skipper

+ XFrameOptions string

+ XSSProtection string

+ type Skipper func(web.Context) bool

+ type StaticConfig struct

+ Browse bool

+ Filesystem http.FileSystem

+ HTML5 bool

+ IgnoreBase bool

+ Index string

+ Root string

+ Skipper Skipper

+ type TimeoutConfig struct

+ ErrorMessage string

+ OnTimeoutRouteErrorHandler func(error, web.Context)

+ Skipper Skipper

+ Timeout time.Duration

+ type TrailingSlashConfig struct

+ RedirectCode int

+ type ValuesExtractor func(web.Context) ([]string, error)

+ func CreateExtractors(lookups string) ([]ValuesExtractor, error)

v0.4.1

May 22, 2026

v0.4.0

Apr 21, 2026

v0.3.0

Apr 9, 2026

v0.2.0

Apr 8, 2026

v0.1.0

Apr 6, 2026