middlerware

Documentation

Overview

Package middlerware provides middleware functions

Index

• Constants
• func CORSMiddleware(allowOrigin string) gin.HandlerFunc
• func Ginzap(logger *zap.Logger, timeFormat string, utc bool) gin.HandlerFunc
• func RecoveryWithZap(logger *zap.Logger, stack bool) gin.HandlerFunc
• func UUIDMiddleware() gin.HandlerFunc

Constants

const XRequestID = "X-Request-Id"

Functions

func CORSMiddleware

func CORSMiddleware(allowOrigin string) gin.HandlerFunc

CORSMiddleware - cors middleware.

func Ginzap

func Ginzap(logger *zap.Logger, timeFormat string, utc bool) gin.HandlerFunc

Ginzap returns a gin.HandlerFunc (middleware) that logs requests using uber-go/zap.

Requests with errors are logged using zap.Error(). Requests without errors are logged using zap.Info().

It receives:

1. A time package format string (e.g. time.RFC3339).
2. A boolean stating whether to use UTC time zone or local.

func RecoveryWithZap

func RecoveryWithZap(logger *zap.Logger, stack bool) gin.HandlerFunc

RecoveryWithZap returns a gin.HandlerFunc (middleware) that recovers from any panics and logs requests using uber-go/zap. All errors are logged using zap.Error(). stack means whether output the stack info. The stack info is easy to find where the error occurs but the stack info is too large. nolint gocognit

func UUIDMiddleware

func UUIDMiddleware() gin.HandlerFunc