middleware

Nov 22, 2024

Changes in this version

+ var DefaultGZipOptions = GZipOptions

+ type GZipOption func(*GZipOptions)

+ func GZipWithLevel(v int) GZipOption

+ func GZipWithMinSize(v int) GZipOption

+ type GZipOptions struct

+ CompressionLevel int

+ MinSize int

type Middleware

+ func GZip(opts ...GZipOption) Middleware

+ func GZipWithOptions(opts GZipOptions) Middleware

Jul 7, 2023

Changes in this version

type Middleware

+ func Referer(opts ...RefererOption) Middleware

+ func RefererWithOptions(opts RefererOptions) Middleware

+ type RefererOption func(*RefererOptions)

+ func RefererWithRequestHeader(v ...string) RefererOption

+ func RefererWithSetContext(v bool) RefererOption

+ type RefererOptions struct

+ RequestHeader []string

+ SetContext bool

+ func GetDefaultRefererOptions() RefererOptions

Mar 21, 2023

Changes in this version

+ func LoggerLabelerFromContext(ctx context.Context) (context.Context, *log.Labeler)

+ func LoggerLabelerFromRequest(r *http.Request) (*http.Request, *log.Labeler)

type LoggerOption

+ func LoggerWithInjectLabeler(v bool) LoggerOption

type LoggerOptions

+ InjectLabeler bool

Dec 27, 2022

Changes in this version

+ func DefaultJWTClaimsHandler(l *zap.Logger, w http.ResponseWriter, r *http.Request, claims jwt2.Claims) bool

+ type JWTClaimsHandler func(*zap.Logger, http.ResponseWriter, *http.Request, jwt2.Claims) bool

type JWTOption

+ func JWTWithClaimsHandler(v JWTClaimsHandler) JWTOption

type JWTOptions

+ ClaimsHandler JWTClaimsHandler

Sep 12, 2022

Changes in this version

type LoggerOption

+ func LoggerWithMinErrorCode(v int) LoggerOption

+ func LoggerWithMinWarnCode(v int) LoggerOption

type LoggerOptions

+ MinErrorCode int

+ MinWarnCode int

Aug 16, 2022

Changes in this version

type RequestIDOptions

+ Provider provider.RequestID

Aug 12, 2022

Changes in this version

type RequestIDOption

+ func RequestIDWithRequestHeader(v ...string) RequestIDOption

+ func RequestIDWithSetContext(v bool) RequestIDOption

+ func RequestIDWithSetRequestHeader(v bool) RequestIDOption

type RequestIDOptions

+ RequestHeader []string

+ SetContext bool

+ SetRequestHeader bool

May 9, 2022

Changes in this version

type TelemetryOption

+ func TelemetryWithInjectPropagationHeader(v bool) TelemetryOption

type TelemetryOptions

+ InjectPropagationHeader bool

Mar 14, 2022

Changes in this version

+ const ContextKeyTrackingID

+ const DefaultTrackingIDCookieName

+ func DefaultTrackingIDGenerator() string

+ func TrackingIDFromContext(ctx context.Context) string

type Middleware

+ func TrackingID(opts ...TrackingIDOption) Middleware

+ func TrackingIDWithOptions(opts TrackingIDOptions) Middleware

+ type TrackingIDGenerator func() string

+ type TrackingIDOption func(*TrackingIDOptions)

+ func TrackingIDWithCookie(v cookie.Cookie) TrackingIDOption

+ func TrackingIDWithGenerator(v TrackingIDGenerator) TrackingIDOption

+ func TrackingIDWithHeader(v string) TrackingIDOption

+ func TrackingIDWithSetContext(v bool) TrackingIDOption

+ func TrackingIDWithSetCookie(v bool) TrackingIDOption

+ func TrackingIDWithSetHeader(v bool) TrackingIDOption

+ type TrackingIDOptions struct

+ Cookie cookie.Cookie

+ Generator TrackingIDGenerator

+ Header string

+ SetContext bool

+ SetCookie bool

+ SetHeader bool

+ func GetDefaultTrackingIDOptions() TrackingIDOptions

Sep 10, 2021

Changes in this version

type Middleware

+ func PoweredByHeader(opts ...PoweredByHeaderOption) Middleware

+ func PoweredByHeaderWithOptions(opts PoweredByHeaderOptions) Middleware

+ func ServerHeader(opts ...ServerHeaderOption) Middleware

+ func ServerHeaderWithOptions(opts ServerHeaderOptions) Middleware

+ type PoweredByHeaderOption func(*PoweredByHeaderOptions)

+ func PoweredByHeaderWithHeader(v string) PoweredByHeaderOption

+ func PoweredByHeaderWithMessage(v string) PoweredByHeaderOption

+ type PoweredByHeaderOptions struct

+ Header string

+ Message string

+ func GetDefaultPoweredByHeaderOptions() PoweredByHeaderOptions

+ type ServerHeaderOption func(*ServerHeaderOptions)

+ func ServerHeaderWithHeader(v string) ServerHeaderOption

+ func ServerHeaderWithName(v string) ServerHeaderOption

+ type ServerHeaderOptions struct

+ Header string

+ Name string

+ func GetDefaultServerHeaderOptions() ServerHeaderOptions

type TelemetryOption

+ func TelemetryWithName(v string) TelemetryOption

+ func TelemetryWithOtelOpts(v ...otelhttp.Option) TelemetryOption

type TelemetryOptions

+ Name string

Sep 8, 2021

Changes in this version

type LoggerOption

+ func LoggerWithMessage(v string) LoggerOption

type LoggerOptions

+ Message string

type TelemetryOptions

+ OtelOpts []otelhttp.Option

Sep 7, 2021

Changes in this version

type JWTOption

+ func JWTWithSetContext(v bool) JWTOption

type JWTOptions

+ SetContext bool

Sep 7, 2021

Changes in this version

+ const ContextKeySessionID

+ const DefaultSessionIDCookieName

+ func DefaultJWTClaimsProvider() jwt2.Claims

+ func DefaultJWTErrorHandler(l *zap.Logger, w http.ResponseWriter, r *http.Request, err error) bool

+ func DefaultJWTInvalidTokenHandler(l *zap.Logger, w http.ResponseWriter, r *http.Request, token *jwt2.Token) bool

+ func DefaultJWTMissingTokenHandler(l *zap.Logger, w http.ResponseWriter, r *http.Request) (jwt2.Claims, bool)

+ func DefaultSessionIDGenerator() string

+ func RequiredJWTMissingTokenHandler(l *zap.Logger, w http.ResponseWriter, r *http.Request) (jwt2.Claims, bool)

+ func SessionIDFromContext(ctx context.Context) string

+ func WrapResponseWriter(w http.ResponseWriter) *responseWriter

+ type BasicAuthOption func(*BasicAuthOptions)

+ func BasicAuthWithRealm(v string) BasicAuthOption

+ type BasicAuthOptions struct

+ Realm string

+ func GetDefaultBasicAuthOptions() BasicAuthOptions

+ type CORSOption func(*CORSOptions)

+ func CORSWithAllowCredentials(v bool) CORSOption

+ func CORSWithAllowHeaders(v ...string) CORSOption

+ func CORSWithAllowMethods(v ...string) CORSOption

+ func CORSWithAllowOrigins(v ...string) CORSOption

+ func CORSWithExposeHeaders(v ...string) CORSOption

+ func CORSWithMaxAge(v int) CORSOption

+ type CORSOptions struct

+ AllowCredentials bool

+ AllowHeaders []string

+ AllowMethods []string

+ AllowOrigins []string

+ ExposeHeaders []string

+ MaxAge int

+ func GetDefaultCORSOptions() CORSOptions

+ type CookieTokenProviderOption func(*CookieTokenProviderOptions)

+ type CookieTokenProviderOptions struct

+ func GetDefaultCookieTokenOptions() CookieTokenProviderOptions

+ type HeaderTokenProviderOption func(*HeaderTokenProviderOptions)

+ func HeaderTokenProviderWithHeader(v string) HeaderTokenProviderOption

+ func HeaderTokenProviderWithPrefix(v string) HeaderTokenProviderOption

+ type HeaderTokenProviderOptions struct

+ Header string

+ Prefix string

+ func GetDefaultHeaderTokenOptions() HeaderTokenProviderOptions

+ type JWTClaimsProvider func() jwt2.Claims

+ type JWTErrorHandler func(*zap.Logger, http.ResponseWriter, *http.Request, error) bool

+ type JWTInvalidTokenHandler func(*zap.Logger, http.ResponseWriter, *http.Request, *jwt2.Token) bool

+ type JWTMissingTokenHandler func(*zap.Logger, http.ResponseWriter, *http.Request) (jwt2.Claims, bool)

+ type JWTOption func(*JWTOptions)

+ func JWTWithClaimsProvider(v JWTClaimsProvider) JWTOption

+ func JWTWithErrorHandler(v JWTErrorHandler) JWTOption

+ func JWTWithInvalidTokenHandler(v JWTInvalidTokenHandler) JWTOption

+ func JWTWithMissingTokenHandler(v JWTMissingTokenHandler) JWTOption

+ func JWTWithTokenProvider(v TokenProvider) JWTOption

+ type JWTOptions struct

+ ClaimsProvider JWTClaimsProvider

+ ErrorHandler JWTErrorHandler

+ InvalidTokenHandler JWTInvalidTokenHandler

+ MissingTokenHandler JWTMissingTokenHandler

+ TokenProvider TokenProvider

+ func GetDefaultJWTOptions() JWTOptions

+ type LoggerOption func(*LoggerOptions)

+ type LoggerOptions struct

+ func GetDefaultLoggerOptions() LoggerOptions

type Middleware

+ func BasicAuthWithOptions(username string, passwordHash []byte, opts BasicAuthOptions) Middleware

+ func CORSWithOptions(opts CORSOptions) Middleware

+ func JWT(jwt *jwt.JWT, contextKey interface{}, opts ...JWTOption) Middleware

+ func JWTWithOptions(jwt *jwt.JWT, contextKey interface{}, opts JWTOptions) Middleware

+ func LoggerWithOptions(opts LoggerOptions) Middleware

+ func RecoverWithOptions(opts RecoverOptions) Middleware

+ func RequestIDWithOptions(opts RequestIDOptions) Middleware

+ func ResponseTime(opts ...ResponseTimeOption) Middleware

+ func ResponseTimeWithOptions(opts ResponseTimeOptions) Middleware

+ func Server(name string, opts ...ServerOption) Middleware

+ func ServerWithOptions(name string, opts ServerOptions) Middleware

+ func SessionID(opts ...SessionIDOption) Middleware

+ func SessionIDWithOptions(opts SessionIDOptions) Middleware

+ func Skip(mw Middleware, skippers ...Skipper) Middleware

+ func TelemetryWithOptions(name string, opts TelemetryOptions) Middleware

+ func TokenAuth(token string, opts ...TokenAuthOption) Middleware

+ func TokenAuthWithOptions(token string, opts TokenAuthOptions) Middleware

+ type RecoverOption func(*RecoverOptions)

+ func RecoverWithDisablePrintStack(v bool) RecoverOption

+ type RecoverOptions struct

+ DisablePrintStack bool

+ func GetDefaultRecoverOptions() RecoverOptions

+ type RequestIDGenerator func() string

+ type RequestIDOption func(*RequestIDOptions)

+ func RequestIDWithGenerator(v RequestIDGenerator) RequestIDOption

+ func RequestIDWithResponseHeader(v string) RequestIDOption

+ func RequestIDWithSetResponseHeader(v bool) RequestIDOption

+ type RequestIDOptions struct

+ Generator RequestIDGenerator

+ ResponseHeader string

+ SetResponseHeader bool

+ func GetDefaultRequestIDOptions() RequestIDOptions

+ type ResponseTimeOption func(*ResponseTimeOptions)

+ func ResponseTimeWithMaxDuration(v time.Duration) ResponseTimeOption

+ func ResponseTimeWithMaxDurationMessage(v string) ResponseTimeOption

+ func ResponseTimeWithSetHeader(v bool) ResponseTimeOption

+ type ResponseTimeOptions struct

+ MaxDuration time.Duration

+ MaxDurationMessage string

+ SetHeader bool

+ func GetDefaultResponseTimeOptions() ResponseTimeOptions

+ type ServerOption func(*ServerOptions)

+ type ServerOptions struct

+ Header string

+ func GetDefaultServerOptions() ServerOptions

+ type SessionIDGenerator func() string

+ type SessionIDOption func(*SessionIDOptions)

+ func SessionIDWithCookie(v cookie.Cookie) SessionIDOption

+ func SessionIDWithGenerator(v SessionIDGenerator) SessionIDOption

+ func SessionIDWithHeader(v string) SessionIDOption

+ func SessionIDWithSetContext(v bool) SessionIDOption

+ func SessionIDWithSetCookie(v bool) SessionIDOption

+ func SessionIDWithSetHeader(v bool) SessionIDOption

+ type SessionIDOptions struct

+ Cookie cookie.Cookie

+ Generator SessionIDGenerator

+ Header string

+ SetContext bool

+ SetCookie bool

+ SetHeader bool

+ func GetDefaultSessionIDOptions() SessionIDOptions

+ type Skipper func(*http.Request) bool

+ func RequestURIBlacklistSkipper(uris ...string) Skipper

+ func RequestURIWhitelistSkipper(uris ...string) Skipper

+ type TelemetryOption func(*TelemetryOptions)

+ type TelemetryOptions struct

+ func GetDefaultTelemetryOptions() TelemetryOptions

+ type TokenAuthOption func(*TokenAuthOptions)

+ func TokenAuthWithTokenProvider(v TokenProvider) TokenAuthOption

+ type TokenAuthOptions struct

+ TokenProvider TokenProvider

+ func GetDefaultTokenAuthOptions() TokenAuthOptions

+ type TokenProvider func(r *http.Request) (string, error)

+ func CookieTokenProvider(cookieName string, opts ...CookieTokenProviderOption) TokenProvider

+ func HeaderTokenProvider(opts ...HeaderTokenProviderOption) TokenProvider

Aug 17, 2021

Changes in this version

type Middleware

+ func BasicAuthBcryptHash(user, hashedPassword string) Middleware

Jul 28, 2021

Changes in this version

+ var DefaultCORSConfig = CORSConfig

+ var DefaultLoggerConfig = LoggerConfig

+ var DefaultRecoverConfig = RecoverConfig

+ var DefaultRequestIDConfig = RequestIDConfig

+ var DefaultTelemetryConfig = TelemetryConfig

+ func Compose(l *zap.Logger, handler http.Handler, middlewares ...Middleware) http.Handler

+ func DefaultRequestIDGenerator() string

+ type CORSConfig struct

+ AllowCredentials bool

+ AllowHeaders []string

+ AllowMethods []string

+ AllowOrigins []string

+ ExposeHeaders []string

+ MaxAge int

+ type LoggerConfig struct

+ type Middleware func(*zap.Logger, http.Handler) http.Handler

+ func BasicAuth(user, password string) Middleware

+ func BearerAuth(bearerToken string) Middleware

+ func CORS() Middleware

+ func CORSWithConfig(config CORSConfig) Middleware

+ func Logger() Middleware

+ func LoggerWithConfig(config LoggerConfig) Middleware

+ func Recover() Middleware

+ func RecoverWithConfig(config RecoverConfig) Middleware

+ func RequestID() Middleware

+ func RequestIDWithConfig(config RequestIDConfig) Middleware

+ func Telemetry() Middleware

+ func TelemetryWithConfig(config TelemetryConfig) Middleware

+ type RecoverConfig struct

+ DisablePrintStack bool

+ type RequestIDConfig struct

+ Generator func() string

+ type TelemetryConfig struct

+ ServiceName string