ginhelper

Documentation

Index

• func DefaultWithLogger(logger *log.Logger) *gin.Engine
• func ErrorWrapper(h Handler) gin.HandlerFunc
• func LoggerMw(logger *log.Logger) gin.HandlerFunc
• func ReplyError(ctx *gin.Context, err error)
• type BizError
  • func NewBizError(status, code int, message string) *BizError
  • func NewFromError(status, code int, err error) *BizError
  • func (e *BizError) Error() string
  • func (e *BizError) Unwrap() error
• type Handler

Functions

func DefaultWithLogger

func DefaultWithLogger(logger *log.Logger) *gin.Engine

DefaultWithLogger create a gin engine with log middleware.

func ErrorWrapper

func ErrorWrapper(h Handler) gin.HandlerFunc

ErrorWrapper can convert our Handler to gin.HandlerFunc with our error handler.

func LoggerMw

func LoggerMw(logger *log.Logger) gin.HandlerFunc

LoggerMw create a gin request log middleware.

func ReplyError

func ReplyError(ctx *gin.Context, err error)

ReplyError handle multi error 1. BizError, return status: BizError.Status and BizError as json body 2. ValidationErrors, return status: 400, and json error body 3. other, return status 500 and json error body.

Types

type BizError

type BizError struct {
	Status  int    `json:"-"`
	Code    int    `json:"code"`
	Message string `json:"message,omitempty"`
	Err     error  `json:"-"`
}

BizError is our custom error type.

func NewBizError

func NewBizError(status, code int, message string) *BizError

NewBizError create new BizError.

func NewFromError

func NewFromError(status, code int, err error) *BizError

NewFromError can create BizError from error.

func (*BizError) Error

func (e *BizError) Error() string

Error impl golang error.Error.

func (*BizError) Unwrap

func (e *BizError) Unwrap() error

Unwrap get the inner error.

type Handler

type Handler = func(c *gin.Context) error

Handler is same as gin handler but can return error.