middleware

Documentation

Index

• Variables
• func AllowedPathPrefixes(c *gin.Context, prefixes ...string) bool
• func AuthWithConfig(config AuthConfig) gin.HandlerFunc
• func Empty() gin.HandlerFunc
• func Logger() gin.HandlerFunc
• func LoggerWithConfig(config LoggerConfig) gin.HandlerFunc
• func Recovery() gin.HandlerFunc
• func RecoveryWithConfig(config RecoveryConfig) gin.HandlerFunc
• func SkippedPathPrefixes(c *gin.Context, prefixes ...string) bool
• func Trace() gin.HandlerFunc
• func TraceWithConfig(config TraceConfig) gin.HandlerFunc
• type AuthConfig
• type LoggerConfig
• type RecoveryConfig
• type TraceConfig

Variables

var DefaultLoggerConfig = LoggerConfig{
	MaxOutputRequestBodyLen:  1024 * 1024,
	MaxOutputResponseBodyLen: 1024 * 1024,
}

var DefaultRecoveryConfig = RecoveryConfig{
	Skip: 3,
}

var DefaultTraceConfig = TraceConfig{
	RequestHeaderKey: "X-Request-Id",
	ResponseTraceKey: "X-Trace-Id",
}

Functions

func AllowedPathPrefixes

func AllowedPathPrefixes(c *gin.Context, prefixes ...string) bool

func AuthWithConfig

func AuthWithConfig(config AuthConfig) gin.HandlerFunc

func Empty

func Empty() gin.HandlerFunc

func Logger

func Logger() gin.HandlerFunc

func LoggerWithConfig

func LoggerWithConfig(config LoggerConfig) gin.HandlerFunc

func Recovery

func Recovery() gin.HandlerFunc

func RecoveryWithConfig

func RecoveryWithConfig(config RecoveryConfig) gin.HandlerFunc

func SkippedPathPrefixes

func SkippedPathPrefixes(c *gin.Context, prefixes ...string) bool

func Trace

func Trace() gin.HandlerFunc

func TraceWithConfig

func TraceWithConfig(config TraceConfig) gin.HandlerFunc

Types

type AuthConfig

type AuthConfig struct {
	AllowedPathPrefixes []string
	SkippedPathPrefixes []string
	Skipper             func(*gin.Context) bool
	ParseUser           func(*gin.Context) (string, error)
}

type LoggerConfig

type LoggerConfig struct {
	SkippedPathPrefixes      []string
	AllowedPathPrefixes      []string
	MaxOutputRequestBodyLen  int
	MaxOutputResponseBodyLen int
}

type RecoveryConfig

type RecoveryConfig struct {
	Skip int
}

type TraceConfig

type TraceConfig struct {
	SkippedPathPrefixes []string
	AllowedPathPrefixes []string
	RequestHeaderKey    string
	ResponseTraceKey    string
}