middleware

Documentation

Index

• Constants
• Variables
• func AuthMiddleware() gin.HandlerFunc
• func HasUnSupportedQueryParams(req *http.Request, supportedParams map[string]bool) bool
• func InternalAuthMiddleware() gin.HandlerFunc
• func QueryParamsCheckMiddleware(lgr logger.Logger) gin.HandlerFunc
• func ReqIDMiddleware() gin.HandlerFunc
• func RequestLogMiddleware(lgr logger.Logger, fr *flightrecorder.Recorder) gin.HandlerFunc
• func ResponseHeadersMiddleware() gin.HandlerFunc
• type ContextKey

Constants

const (
	// RequestIdentifier is the header name for request ID.
	RequestIdentifier = "X-Request-ID"
)

const (
	// SlowRequestThreshold defines when to capture flight recorder traces.
	SlowRequestThreshold = 500 * time.Millisecond
)

Variables

var AllowedQueryParams = map[string]map[string]bool{
	http.MethodGet + "/ecommerce/v1/orders":        GetOrdersListReqParams,
	http.MethodPost + "/ecommerce/v1/orders":       nil,
	http.MethodGet + "/ecommerce/v1/orders/:id":    nil,
	http.MethodDelete + "/ecommerce/v1/orders/:id": nil,
}

var GetOrdersListReqParams = map[string]bool{
	"limit": true,
	"page":  true,
}

Functions

func AuthMiddleware

func AuthMiddleware() gin.HandlerFunc

func HasUnSupportedQueryParams

func HasUnSupportedQueryParams(req *http.Request, supportedParams map[string]bool) bool

func InternalAuthMiddleware

func InternalAuthMiddleware() gin.HandlerFunc

func QueryParamsCheckMiddleware

func QueryParamsCheckMiddleware(lgr logger.Logger) gin.HandlerFunc

QueryParamsCheckMiddleware - Middleware to check for unsupported query parameters.

func ReqIDMiddleware

func ReqIDMiddleware() gin.HandlerFunc

ReqIDMiddleware injects a request ID into the context and response header, creates one if it is not present already.

func RequestLogMiddleware

func RequestLogMiddleware(lgr logger.Logger, fr *flightrecorder.Recorder) gin.HandlerFunc

func ResponseHeadersMiddleware

func ResponseHeadersMiddleware() gin.HandlerFunc

Types

type ContextKey

type ContextKey string

ContextKey is a type for context keys.