exgin

README

ExGin

go get -u github.com/ergoapi/exgin

Documentation

Index

• func Bind(c *gin.Context, ptr interface{})
• func ExCors() gin.HandlerFunc
• func ExLog(skip ...string) gin.HandlerFunc
• func ExRecovery() gin.HandlerFunc
• func ExTraceID() gin.HandlerFunc
• func GinsAbort(c *gin.Context, msg string, args ...interface{})
• func GinsAbortWithCode(c *gin.Context, respcode int, msg string, args ...interface{})
• func GinsCodeData(c *gin.Context, code int, data interface{}, err error)
• func GinsCustomCodeResp(c *gin.Context, code int, obj interface{})
• func GinsCustomResp(c *gin.Context, obj interface{})
• func GinsData(c *gin.Context, data interface{}, err error)
• func GinsErrorData(c *gin.Context, code int, data interface{}, err error)
• func GinsHeader(c *gin.Context, headerkey string) string
• func GinsOffset(c *gin.Context, limit int) int
• func GinsParamInt(c *gin.Context, field string) int
• func GinsParamInt64(c *gin.Context, field string) int64
• func GinsParamStr(c *gin.Context, field string) string
• func GinsQueryBool(c *gin.Context, key string, defaultVal ...bool) bool
• func GinsQueryInt(c *gin.Context, key string, defaultVal ...int) int
• func GinsQueryInt64(c *gin.Context, key string, defaultVal ...int64) int64
• func GinsQueryStr(c *gin.Context, key string, defaultval ...string) string
• func GinsQueryStrNull(c *gin.Context, key string) string
• func Host(c *gin.Context) string
• func Init(c *Config) *gin.Engine
• func RealIP(c *gin.Context) string
• type APICustomRespBody
• type Config
  • func (c *Config) GinSet(r *gin.Engine)

Functions

func Bind

func Bind(c *gin.Context, ptr interface{})

func ExCors

func ExCors() gin.HandlerFunc

ExCors excors middleware

func ExLog

func ExLog(skip ...string) gin.HandlerFunc

ExLog ex logrus middleware

func ExRecovery

func ExRecovery() gin.HandlerFunc

ExRecovery logrus recovery

func ExTraceID

func ExTraceID() gin.HandlerFunc

func GinsAbort

func GinsAbort(c *gin.Context, msg string, args ...interface{})

func GinsAbortWithCode

func GinsAbortWithCode(c *gin.Context, respcode int, msg string, args ...interface{})

func GinsCodeData

func GinsCodeData(c *gin.Context, code int, data interface{}, err error)

func GinsCustomCodeResp

func GinsCustomCodeResp(c *gin.Context, code int, obj interface{})

func GinsCustomResp

func GinsCustomResp(c *gin.Context, obj interface{})

func GinsData

func GinsData(c *gin.Context, data interface{}, err error)

func GinsErrorData

func GinsErrorData(c *gin.Context, code int, data interface{}, err error)

func GinsHeader

func GinsHeader(c *gin.Context, headerkey string) string

GinsHeader header key

func GinsOffset

func GinsOffset(c *gin.Context, limit int) int

GinsOffset offset

func GinsParamInt

func GinsParamInt(c *gin.Context, field string) int

GinsParamInt param str

func GinsParamInt64

func GinsParamInt64(c *gin.Context, field string) int64

GinsParamInt64 param str

func GinsParamStr

func GinsParamStr(c *gin.Context, field string) string

GinsParamStr param str

func GinsQueryBool

func GinsQueryBool(c *gin.Context, key string, defaultVal ...bool) bool

GinsQueryBool query bool

func GinsQueryInt

func GinsQueryInt(c *gin.Context, key string, defaultVal ...int) int

GinsQueryInt query int

func GinsQueryInt64

func GinsQueryInt64(c *gin.Context, key string, defaultVal ...int64) int64

GinsQueryInt64 querry int64

func GinsQueryStr

func GinsQueryStr(c *gin.Context, key string, defaultval ...string) string

GinsQueryStr query string

func GinsQueryStrNull

func GinsQueryStrNull(c *gin.Context, key string) string

GinsQueryStrNull query string

func Host

func Host(c *gin.Context) string

func Init

func Init(c *Config) *gin.Engine

Init init gin engine

func RealIP

func RealIP(c *gin.Context) string

Types

type APICustomRespBody

type APICustomRespBody struct {
	Code      int         `json:"code"`
	Data      interface{} `json:"data"`
	Message   string      `json:"message"`
	Timestamp int         `json:"timestamp"`
}

APICustomRespBody swag api resp body

type Config

type Config struct {
	Debug       bool
	Gops        bool
	GopsPath    string
	Pprof       bool
	PprofPath   string
	Cors        bool
	Metrics     bool
	MetricsPath string
}

func (*Config) GinSet

func (c *Config) GinSet(r *gin.Engine)