zmiddlewares

Documentation

Index

• Constants
• func CacheMiddleware(metricServer metrics.TaskMetrics, cache zcache.ZCache, ...) func(next http.Handler) http.Handler
• func GetRoutePattern(r *http.Request) string
• func GetSubRoutePattern(r *http.Request) string
• func JWTUsageMiddleware(zCache zcache.RemoteCache, tokenDetailsTTL, usageMetricTTL time.Duration) func(next http.Handler) http.Handler
• func LoggingMiddleware(options LoggingMiddlewareOptions) func(http.Handler) http.Handler
• func ParseCacheConfigPaths(paths map[string]string) (domain.CacheConfig, error)
• func PathToRegexp(path string) *regexp.Regexp
• func RegisterRequestMetrics(metricsServer metrics.TaskMetrics) []error
• type CacheProcessedPath
• type CorsOptions
• type LoggingMiddlewareOptions
• type Middleware
  • func Cors(options CorsOptions) Middleware
  • func DefaultCors() Middleware
  • func ErrorHandlerMiddleware() Middleware
  • func Logger(options LoggingMiddlewareOptions) Middleware
  • func RateLimit(maxRPM int) Middleware
  • func RateLimitByFullPath(maxRPM int) Middleware
  • func RequestID() Middleware
  • func RequestMetrics(metricsServer metrics.TaskMetrics) Middleware

Constants

const (
	PathUsageByJWTKey = "jwt_path_usage"
)

const (
	RequestIDHeader = "X-Request-ID"
)

Functions

func CacheMiddleware

func CacheMiddleware(metricServer metrics.TaskMetrics, cache zcache.ZCache, config domain.CacheConfig) func(next http.Handler) http.Handler

func GetRoutePattern

func GetRoutePattern(r *http.Request) string

func GetSubRoutePattern

func GetSubRoutePattern(r *http.Request) string

func JWTUsageMiddleware

func JWTUsageMiddleware(zCache zcache.RemoteCache, tokenDetailsTTL, usageMetricTTL time.Duration) func(next http.Handler) http.Handler

func LoggingMiddleware

func LoggingMiddleware(options LoggingMiddlewareOptions) func(http.Handler) http.Handler

func ParseCacheConfigPaths

func ParseCacheConfigPaths(paths map[string]string) (domain.CacheConfig, error)

func PathToRegexp

func PathToRegexp(path string) *regexp.Regexp

func RegisterRequestMetrics

func RegisterRequestMetrics(metricsServer metrics.TaskMetrics) []error

Types

type CacheProcessedPath

type CacheProcessedPath struct {
	Regex *regexp.Regexp
	TTL   time.Duration
}

type CorsOptions

type CorsOptions struct {
	AllowedOrigins     []string
	AllowOriginFunc    func(r *http.Request, origin string) bool
	AllowedMethods     []string
	AllowedHeaders     []string
	ExposedHeaders     []string
	AllowCredentials   bool
	MaxAge             int
	OptionsPassthrough bool
	Debug              bool
}

type LoggingMiddlewareOptions

type LoggingMiddlewareOptions struct {
	ExcludePaths []string
	Enable       bool
}

type Middleware

type Middleware func(next http.Handler) http.Handler

func Cors

func Cors(options CorsOptions) Middleware

func DefaultCors

func DefaultCors() Middleware

func ErrorHandlerMiddleware

func ErrorHandlerMiddleware() Middleware

func Logger

func Logger(options LoggingMiddlewareOptions) Middleware

func RateLimit

func RateLimit(maxRPM int) Middleware

func RateLimitByFullPath

func RateLimitByFullPath(maxRPM int) Middleware

func RequestID

func RequestID() Middleware

func RequestMetrics

func RequestMetrics(metricsServer metrics.TaskMetrics) Middleware