ginx

Documentation

Index

• func InitErrCodeMetrics(opt prometheus.CounterOpts)
• func Wrap(l logx.Logger, bizFn func(ctx *gin.Context) (Result, error)) gin.HandlerFunc
• func WrapBody[T any](l logx.Logger, bizFn func(ctx *gin.Context, req T) (Result, error)) gin.HandlerFunc
• type Handler
• type Result
  • func BizError(msg string) Result
  • func InternalError() Result
  • func InternalErrorWithMsg(msg string) Result
  • func InvalidParam() Result
  • func InvalidParamWithMsg(msg string) Result
  • func InvalidToken() Result
  • func NoPermission() Result
  • func NotFound() Result
  • func Success() Result
  • func SuccessWithData(data any) Result
  • func SuccessWithMsg(msg string) Result

Functions

func InitErrCodeMetrics

func InitErrCodeMetrics(opt prometheus.CounterOpts)

InitErrCodeMetrics 初始化错误码统计 注意：要使用wrap功能，必须调用该方法初始化vector

func Wrap

func Wrap(l logx.Logger, bizFn func(ctx *gin.Context) (Result, error)) gin.HandlerFunc

func WrapBody

func WrapBody[T any](l logx.Logger, bizFn func(ctx *gin.Context, req T) (Result, error)) gin.HandlerFunc

Types

type Handler

type Handler interface {
	RegisterRoutes(server *gin.RouterGroup)
}

type Result

type Result struct {
	Code int    `json:"code"`
	Msg  string `json:"msg"`
	Data any    `json:"data"`
}

func BizError

func BizError(msg string) Result

func InternalError

func InternalError() Result

func InternalErrorWithMsg

func InternalErrorWithMsg(msg string) Result

func InvalidParam

func InvalidParam() Result

func InvalidParamWithMsg

func InvalidParamWithMsg(msg string) Result

func InvalidToken

func InvalidToken() Result

func NoPermission

func NoPermission() Result

func NotFound

func NotFound() Result

func Success

func Success() Result

func SuccessWithData

func SuccessWithData(data any) Result

func SuccessWithMsg

func SuccessWithMsg(msg string) Result