middleware

Documentation

Index

• func BasicAuth(realm string, credentials map[string]string) zoox.Middleware
• func CORS(cfg ...*CorsConfig) zoox.Middleware
• func Gzip(cfg ...*GzipConfig) zoox.Middleware
• func HealthCheck() zoox.Middleware
• func Jwt(secret string, algorithm ...string) zoox.Middleware
• func Logger() zoox.Middleware
• func Proxy(cfg *ProxyConfig) zoox.Middleware
• func RateLimit(cfg *RateLimitConfig) zoox.Middleware
• func RealIP() zoox.Middleware
• func Recovery() zoox.Middleware
• func RequestID() zoox.Middleware
• func Rewrite(cfg ...*RewriteConfig) zoox.Middleware
• func Timeout(timeout time.Duration) zoox.Middleware
• type CorsConfig
  • func DefaultCorsConfig() *CorsConfig
• type GzipConfig
• type ProxyConfig
• type ProxyRewrite
• type RateLimitConfig
• type RewriteConfig

Functions

func BasicAuth

func BasicAuth(realm string, credentials map[string]string) zoox.Middleware

BasicAuth is a middleware that authenticates via Basic Auth.

func CORS

func CORS(cfg ...*CorsConfig) zoox.Middleware

CORS is a middleware for handling CORS (Cross-Origin Resource Sharing)

func Gzip

func Gzip(cfg ...*GzipConfig) zoox.Middleware

Gzip is a gzip moddleware for zoox.

func HealthCheck

func HealthCheck() zoox.Middleware

HealthCheck is a middleware that checks the health of the application.

func Jwt

func Jwt(secret string, algorithm ...string) zoox.Middleware

Jwt is a middleware that authenticates via JWT.

func Logger

func Logger() zoox.Middleware

Logger is a middleware that logs the request as it goes through the handler.

func Proxy

func Proxy(cfg *ProxyConfig) zoox.Middleware

Proxy is a middleware that authenticates via Basic Auth.

func RateLimit

func RateLimit(cfg *RateLimitConfig) zoox.Middleware

RateLimit middleware for zoox

func RealIP

func RealIP() zoox.Middleware

RealIP is a middleware that adds a "X-Real-IP" header to the request.

func Recovery

func Recovery() zoox.Middleware

Recovery is the recovery middleware

func RequestID

func RequestID() zoox.Middleware

RequestID is a middleware that adds a request ID to the context.

func Rewrite

func Rewrite(cfg ...*RewriteConfig) zoox.Middleware

Rewrite is a middleware that rewrites the request path.

func Timeout

func Timeout(timeout time.Duration) zoox.Middleware

Timeout is a middleware that sets a timeout for the request.

Types

type CorsConfig

type CorsConfig struct {
	IgnoreFunc       func(ctx *zoox.Context) bool
	AllowOrigins     []string
	AllowOriginFunc  func(origin string) bool
	AllowMethods     []string
	AllowHeaders     []string
	AllowCredentials bool
	ExposeHeaders    []string
}

CorsConfig is the configuration for the CORS middleware.

func DefaultCorsConfig

func DefaultCorsConfig() *CorsConfig

DefaultCorsConfig is the default CORS configuration.

type GzipConfig

type GzipConfig struct {
	Level int
	// Options  gzip.Options
	OptionFn gzip.Option
}

GzipConfig is the configuration for gzip middleware.

type ProxyConfig

type ProxyConfig struct {
	Rewrites map[string]ProxyRewrite
}

ProxyConfig is the config of proxy middlewares

type ProxyRewrite

type ProxyRewrite struct {
	Target   string
	Rewrites map[string]string
}

ProxyRewrite ...

type RateLimitConfig

type RateLimitConfig struct {
	Period time.Duration
	Limit  int64
	//
	Namespace string
	//
	RedisHost     string
	RedisPort     int
	RedisDB       int
	RedisPassword string
}

RateLimitConfig ...

type RewriteConfig

type RewriteConfig struct {
	Rewrites map[string]string
}

RewriteConfig is the configuration for the Rewrite middleware.