common

Documentation

Index

• Constants
• Variables
• type BaseHandler
• type ResponseError
  • func NewResponseError(message string, description interface{}, statusCode int) *ResponseError
  • func NewResponseErrorWithErr(message string, err error, statusCode int) *ResponseError
  • func (r ResponseError) Abort(c *gin.Context)
  • func (r ResponseError) Error() string

Constants

const ContextUserID = "userID"

ContextUserID .

const TIMESTAMP = time.RFC3339

TIMESTAMP 是序列号时间戳的格式

Variables

var HTTPClient *resty.Client = resty.New()

HTTPClient is the common HTTP client in project

var JWTRefreshTokenExpDuration time.Duration

JWTRefreshTokenExpDuration 是 jwt refresh token 有效的时长

var JWTSecret string

JWTSecret 是 jwt token 的秘钥

var JWTTokenExpDuration time.Duration

JWTTokenExpDuration 是 jwt token 有效的时长

var Logger = logrus.New()

Logger is the common log agency in project

var MySQLClient *gorm.DB

MySQLClient is the common MySQL client in project

var RedisClient *redis.Client

RedisClient is the common Redis client in project

Types

type BaseHandler

type BaseHandler interface {
	RegisterPublicRoutes(r *gin.RouterGroup)
	RegisterPrivateRoutes(r *gin.RouterGroup)
}

BaseHandler can register gin router group

type ResponseError

type ResponseError struct {
	// contains filtered or unexported fields
}

ResponseError contains error message, description, and statusCode

func NewResponseError

func NewResponseError(message string, description interface{}, statusCode int) *ResponseError

NewResponseError create new ResponseError with specific info

func NewResponseErrorWithErr

func NewResponseErrorWithErr(message string, err error, statusCode int) *ResponseError

NewResponseErrorWithErr create new ResponseError, with err as description

func (ResponseError) Abort

func (r ResponseError) Abort(c *gin.Context)

Abort will abort passed gin reqest and respose the error

func (ResponseError) Error

func (r ResponseError) Error() string