goboot

README

goboot-gin

lamgor666/goboot framework base on gin-gonic/gin

Documentation

Index

• Variables
• func BuildJwt(arg0 interface{}, isRefreshToken bool, claims ...map[string]interface{}) (token string, err error)
• func CorsSettings(settings ...interface{}) *GCorsSettings.Settings
• func DtoBind(ctx *gin.Context, dto interface{}) error
• func ExecuteTimeLogEnabled() bool
• func ExecuteTimeLogLogger(logger ...logx.Logger) logx.Logger
• func GetClientIp(ctx *gin.Context) string
• func GetFormData(ctx *gin.Context) map[string]string
• func GetHeader(ctx *gin.Context, name string) string
• func GetHeaders(ctx *gin.Context) map[string]string
• func GetJwt(ctx *gin.Context) *jwt.Token
• func GetMap(ctx *gin.Context, rules ...interface{}) map[string]interface{}
• func GetMethod(ctx *gin.Context) string
• func GetQueryParams(ctx *gin.Context) map[string]string
• func GetQueryString(ctx *gin.Context, urlencode ...bool) string
• func GetRawBody(ctx *gin.Context) []byte
• func GetRequestUrl(ctx *gin.Context, withQueryString ...bool) string
• func JwtAuthCheck(ctx *gin.Context, settingsKey string)
• func JwtClaim(arg0 interface{}, name string, defaultValue ...interface{}) string
• func JwtClaimBool(arg0 interface{}, name string, defaultValue ...interface{}) bool
• func JwtClaimFloat32(arg0 interface{}, name string, defaultValue ...interface{}) float32
• func JwtClaimFloat64(arg0 interface{}, name string, defaultValue ...interface{}) float64
• func JwtClaimInt(arg0 interface{}, name string, defaultValue ...interface{}) int
• func JwtClaimInt64(arg0 interface{}, name string, defaultValue ...interface{}) int64
• func JwtClaimIntSlice(arg0 interface{}, name string) []int
• func JwtClaimStringSlice(arg0 interface{}, name string) []string
• func JwtPrivateKeyPemFile(fpath ...string) string
• func JwtPublicKeyPemFile(fpath ...string) string
• func JwtSettings(key string, settings ...interface{}) *GJwtSettings.Settings
• func LogRequestBody(flag ...bool) bool
• func ParseJwt(token string, pubpem ...string) (*jwt.Token, error)
• func Pathvariable(ctx *gin.Context, name string, defaultValue ...interface{}) string
• func PathvariableBool(ctx *gin.Context, name string, defaultValue ...interface{}) bool
• func PathvariableFloat32(ctx *gin.Context, name string, defaultValue ...interface{}) float32
• func PathvariableFloat64(ctx *gin.Context, name string, defaultValue ...interface{}) float64
• func PathvariableInt(ctx *gin.Context, name string, defaultValue ...interface{}) int
• func PathvariableInt64(ctx *gin.Context, name string, defaultValue ...interface{}) int64
• func RateLimitCheck(ctx *gin.Context, handlerName string, settings interface{})
• func RatelimiterCacheDir(dir ...string) string
• func RatelimiterLuaFile(fpath ...string) string
• func RedislockCacheDir(dir ...string) string
• func RedislockLuaFile(typ string, fpath ...string) string
• func ReplaceBuiltinErrorHandler(errName string, handler ErrorHandler)
• func ReqParam(ctx *gin.Context, name string, mode int, defaultValue ...interface{}) string
• func ReqParamBool(ctx *gin.Context, name string, defaultValue ...interface{}) bool
• func ReqParamFloat32(ctx *gin.Context, name string, defaultValue ...interface{}) float32
• func ReqParamFloat64(ctx *gin.Context, name string, defaultValue ...interface{}) float64
• func ReqParamInt(ctx *gin.Context, name string, defaultValue ...interface{}) int
• func ReqParamInt64(ctx *gin.Context, name string, defaultValue ...interface{}) int64
• func RequestLogEnabled() bool
• func RequestLogLogger(logger ...logx.Logger) logx.Logger
• func RuntimeLogger(logger ...logx.Logger) logx.Logger
• func SendOutput(ctx *gin.Context, payload ResponsePayload, err error)
• func ValidateCheck(ctx *gin.Context, settings interface{})
• func VerifyJwt(arg0 interface{}, settings *GJwtSettings.Settings) int
• func WithBuiltinErrorHandlers()
• func WithErrorHandler(handler ErrorHandler)
• func WithErrorHandlers(handlers []ErrorHandler)
• type ErrorHandler
• type ResponsePayload

Variables

var Version = "1.0.0"

Functions

func BuildJwt

func BuildJwt(arg0 interface{}, isRefreshToken bool, claims ...map[string]interface{}) (token string, err error)

@param *JwtSettings|string arg0

func CorsSettings

func CorsSettings(settings ...interface{}) *GCorsSettings.Settings

func DtoBind

func DtoBind(ctx *gin.Context, dto interface{}) error

func ExecuteTimeLogEnabled

func ExecuteTimeLogEnabled() bool

func ExecuteTimeLogLogger

func ExecuteTimeLogLogger(logger ...logx.Logger) logx.Logger

func GetClientIp

func GetClientIp(ctx *gin.Context) string

func GetFormData

func GetFormData(ctx *gin.Context) map[string]string

func GetHeader

func GetHeader(ctx *gin.Context, name string) string

func GetHeaders

func GetHeaders(ctx *gin.Context) map[string]string

func GetJwt

func GetJwt(ctx *gin.Context) *jwt.Token

func GetMap

func GetMap(ctx *gin.Context, rules ...interface{}) map[string]interface{}

func GetMethod

func GetMethod(ctx *gin.Context) string

func GetQueryParams

func GetQueryParams(ctx *gin.Context) map[string]string

func GetQueryString

func GetQueryString(ctx *gin.Context, urlencode ...bool) string

func GetRawBody

func GetRawBody(ctx *gin.Context) []byte

func GetRequestUrl

func GetRequestUrl(ctx *gin.Context, withQueryString ...bool) string

func JwtAuthCheck

func JwtAuthCheck(ctx *gin.Context, settingsKey string)

func JwtClaim

func JwtClaim(arg0 interface{}, name string, defaultValue ...interface{}) string

@param *jwt.Token|*gin.Context|string arg0

func JwtClaimBool

func JwtClaimBool(arg0 interface{}, name string, defaultValue ...interface{}) bool

@param *jwt.Token|*gin.Context|string arg0

func JwtClaimFloat32

func JwtClaimFloat32(arg0 interface{}, name string, defaultValue ...interface{}) float32

@param *jwt.Token|*gin.Context|string arg0

func JwtClaimFloat64

func JwtClaimFloat64(arg0 interface{}, name string, defaultValue ...interface{}) float64

@param *jwt.Token|*gin.Context|string arg0

func JwtClaimInt

func JwtClaimInt(arg0 interface{}, name string, defaultValue ...interface{}) int

@param *jwt.Token|*gin.Context|string arg0

func JwtClaimInt64

func JwtClaimInt64(arg0 interface{}, name string, defaultValue ...interface{}) int64

@param *jwt.Token|*gin.Context|string arg0

func JwtClaimIntSlice

func JwtClaimIntSlice(arg0 interface{}, name string) []int

@param *jwt.Token|*gin.Context|string arg0

func JwtClaimStringSlice

func JwtClaimStringSlice(arg0 interface{}, name string) []string

@param *jwt.Token|*gin.Context|string arg0

func JwtPrivateKeyPemFile

func JwtPrivateKeyPemFile(fpath ...string) string

func JwtPublicKeyPemFile

func JwtPublicKeyPemFile(fpath ...string) string

func JwtSettings

func JwtSettings(key string, settings ...interface{}) *GJwtSettings.Settings

func LogRequestBody

func LogRequestBody(flag ...bool) bool

func ParseJwt

func ParseJwt(token string, pubpem ...string) (*jwt.Token, error)

func Pathvariable

func Pathvariable(ctx *gin.Context, name string, defaultValue ...interface{}) string

func PathvariableBool

func PathvariableBool(ctx *gin.Context, name string, defaultValue ...interface{}) bool

func PathvariableFloat32

func PathvariableFloat32(ctx *gin.Context, name string, defaultValue ...interface{}) float32

func PathvariableFloat64

func PathvariableFloat64(ctx *gin.Context, name string, defaultValue ...interface{}) float64

func PathvariableInt

func PathvariableInt(ctx *gin.Context, name string, defaultValue ...interface{}) int

func PathvariableInt64

func PathvariableInt64(ctx *gin.Context, name string, defaultValue ...interface{}) int64

func RateLimitCheck

func RateLimitCheck(ctx *gin.Context, handlerName string, settings interface{})

func RatelimiterCacheDir

func RatelimiterCacheDir(dir ...string) string

func RatelimiterLuaFile

func RatelimiterLuaFile(fpath ...string) string

func RedislockCacheDir

func RedislockCacheDir(dir ...string) string

func RedislockLuaFile

func RedislockLuaFile(typ string, fpath ...string) string

func ReplaceBuiltinErrorHandler

func ReplaceBuiltinErrorHandler(errName string, handler ErrorHandler)

func ReqParam

func ReqParam(ctx *gin.Context, name string, mode int, defaultValue ...interface{}) string

func ReqParamBool

func ReqParamBool(ctx *gin.Context, name string, defaultValue ...interface{}) bool

func ReqParamFloat32

func ReqParamFloat32(ctx *gin.Context, name string, defaultValue ...interface{}) float32

func ReqParamFloat64

func ReqParamFloat64(ctx *gin.Context, name string, defaultValue ...interface{}) float64

func ReqParamInt

func ReqParamInt(ctx *gin.Context, name string, defaultValue ...interface{}) int

func ReqParamInt64

func ReqParamInt64(ctx *gin.Context, name string, defaultValue ...interface{}) int64

func RequestLogEnabled

func RequestLogEnabled() bool

func RequestLogLogger

func RequestLogLogger(logger ...logx.Logger) logx.Logger

func RuntimeLogger

func RuntimeLogger(logger ...logx.Logger) logx.Logger

func SendOutput

func SendOutput(ctx *gin.Context, payload ResponsePayload, err error)

func ValidateCheck

func ValidateCheck(ctx *gin.Context, settings interface{})

func VerifyJwt

func VerifyJwt(arg0 interface{}, settings *GJwtSettings.Settings) int

@param *jwt.Token|string arg0

func WithBuiltinErrorHandlers

func WithBuiltinErrorHandlers()

func WithErrorHandler

func WithErrorHandler(handler ErrorHandler)

func WithErrorHandlers

func WithErrorHandlers(handlers []ErrorHandler)

Types

type ErrorHandler

type ErrorHandler interface {
	GetErrorName() string
	MatchError(err error) bool
	HandleError(err error) ResponsePayload
}

type ResponsePayload

type ResponsePayload interface {
	GetContentType() string
	GetContents() (int, string)
}