serverx

Documentation

Index

• Variables
• func BindHandler(group *gin.RouterGroup, handlers ...any)
• func GetClientIP(ctx *gin.Context) string
• func RenderError(c *gin.Context, err error)
• func RenderSuccess(c *gin.Context, data any)
• func Run(mode string, cfg Config, initRoutes func(engine *gin.Engine))
• func WithAccesslog() gin.HandlerFunc
• func WithCasbin(cfg casbinx.Config) gin.HandlerFunc
• func WithCors(headers ...string) gin.HandlerFunc
• func WithJWT(cfg Config, jwtCfg jwtx.Config) gin.HandlerFunc
• func WithTraceid() gin.HandlerFunc
• type Config

Variables

var Validator *validator.Validate

Validator 参数校验工具

Functions

func BindHandler

func BindHandler(group *gin.RouterGroup, handlers ...any)

BindHandler 注册handler中的方法

func GetClientIP

func GetClientIP(ctx *gin.Context) string

func RenderError

func RenderError(c *gin.Context, err error)

RenderError 返回错误

func RenderSuccess

func RenderSuccess(c *gin.Context, data any)

RenderSuccess 返回成功

func Run

func Run(mode string, cfg Config, initRoutes func(engine *gin.Engine))

func WithAccesslog

func WithAccesslog() gin.HandlerFunc

func WithCasbin

func WithCasbin(cfg casbinx.Config) gin.HandlerFunc

WithCasbin casbin中间件

func WithCors

func WithCors(headers ...string) gin.HandlerFunc

WithCors 跨域

func WithJWT

func WithJWT(cfg Config, jwtCfg jwtx.Config) gin.HandlerFunc

WithJWT 返回JWT Handler

func WithTraceid

func WithTraceid() gin.HandlerFunc

Types

type Config

type Config struct {
	Addr        string   `mapstructure:"addr"`
	CorsHeaders []string `mapstructure:"cors-headers"`
	SwaggerUI   string   `mapstructure:"swagger-ui"`
	RoutePrefix string   `mapstructure:"route-prefix"`
	NonAuth     []string `mapstructure:"non-auth"`
}