ginx

Documentation

Index

• func APIHandler[TReq, TResp any](handler func(context.Context, *TReq) (TResp, error)) func(*gin.Context)
• func APIHandlerWithUriParams[TReq, TResp, TUri any](handler func(context.Context, *TReq, *TUri) (TResp, error)) func(*gin.Context)
• func LogHook(logger *logrus.Logger, notLogged ...string) gin.HandlerFunc
• func LogHookWithConfig(logger *logrus.Logger, config LogHookConfig) gin.HandlerFunc
• func RESTHandler[TReq, TResp any](handler func(context.Context, *TReq) (TResp, error)) func(*gin.Context)
• func RESTHandlerWithUriParams[TReq, TResp, TUri any](handler func(context.Context, *TReq, *TUri) (TResp, error)) func(*gin.Context)
• func RequestID() gin.HandlerFunc
• func Serve(app *gin.Engine, addr string) error
• func ServeWithTimeout(app *gin.Engine, addr string, timeout time.Duration) error
• type APIError
• type APIResponse
• type Empty
• type LogHookConfig
• type Normalizer

Functions

func APIHandler

func APIHandler[TReq, TResp any](handler func(context.Context, *TReq) (TResp, error)) func(*gin.Context)

func APIHandlerWithUriParams

func APIHandlerWithUriParams[TReq, TResp, TUri any](handler func(context.Context, *TReq, *TUri) (TResp, error)) func(*gin.Context)

func LogHook

func LogHook(logger *logrus.Logger, notLogged ...string) gin.HandlerFunc

LogHook creates request logging middleware with exact paths excluded.

func LogHookWithConfig

func LogHookWithConfig(logger *logrus.Logger, config LogHookConfig) gin.HandlerFunc

LogHookWithConfig creates request logging middleware with configurable exclusions. SkipFunc runs after the remaining handlers have completed.

func RESTHandler

func RESTHandler[TReq, TResp any](handler func(context.Context, *TReq) (TResp, error)) func(*gin.Context)

func RESTHandlerWithUriParams

func RESTHandlerWithUriParams[TReq, TResp, TUri any](handler func(context.Context, *TReq, *TUri) (TResp, error)) func(*gin.Context)

func RequestID

func RequestID() gin.HandlerFunc

func Serve

func Serve(app *gin.Engine, addr string) error

func ServeWithTimeout

func ServeWithTimeout(app *gin.Engine, addr string, timeout time.Duration) error

Types

type APIError

type APIError struct {
	Error     string `json:"error"`
	RequestID string `json:"request_id"`
}

type APIResponse

type APIResponse struct {
	Success   bool   `json:"success"`
	Data      any    `json:"data"`
	Error     string `json:"error,omitempty"`
	RequestID string `json:"request_id,omitempty"`
}

type Empty

type Empty struct {
}

type LogHookConfig

type LogHookConfig struct {
	SkipPaths []string
	SkipFunc  gin.Skipper
}

LogHookConfig configures request logging exclusions.

type Normalizer

type Normalizer interface {
	Normalize() bool
}