xhttp

README

xhttp

Documentation

Index

• Variables
• func BadRequestResponse(ctx *gin.Context, err error)
• func ForbiddenResponse(ctx *gin.Context, err error)
• func GatewayTimeoutResponse(ctx *gin.Context, err error)
• func InternalServerErrorResponse(ctx *gin.Context, err error)
• func NotFoundResponse(ctx *gin.Context, err error)
• func NotImplementedResponse(ctx *gin.Context, err error)
• func ServiceUnavailableResponse(ctx *gin.Context, err error)
• func SuccessResponse(ctx *gin.Context, data interface{})
• func UnauthorizedResponse(ctx *gin.Context, err error)
• type Authorization
• type JwtOptions
• type Response
• type XHttp
  • func NewXHttp() *XHttp
  • func (h *XHttp) AddOnStartFunc(fn []func())
  • func (h *XHttp) AddOnStopFunc(fn []func())
  • func (h *XHttp) RegisterGlobalMiddleware(middles []func(c *gin.Context))
  • func (h *XHttp) Start()
• type XJwt
  • func NewXJwt(options JwtOptions) *XJwt
  • func (j *XJwt) GenerateToken(claims jwt.Claims) (sign string, err error)
  • func (j *XJwt) Middleware(exception map[string]byte) gin.HandlerFunc

Variables

var (
	ErrEmptyToken   = errors.New("not found token in header")
	ErrTokenInvalid = errors.New("token is invalid")
)

Functions

func BadRequestResponse

func BadRequestResponse(ctx *gin.Context, err error)

func ForbiddenResponse

func ForbiddenResponse(ctx *gin.Context, err error)

func GatewayTimeoutResponse

func GatewayTimeoutResponse(ctx *gin.Context, err error)

func InternalServerErrorResponse

func InternalServerErrorResponse(ctx *gin.Context, err error)

func NotFoundResponse

func NotFoundResponse(ctx *gin.Context, err error)

func NotImplementedResponse

func NotImplementedResponse(ctx *gin.Context, err error)

func ServiceUnavailableResponse

func ServiceUnavailableResponse(ctx *gin.Context, err error)

func SuccessResponse

func SuccessResponse(ctx *gin.Context, data interface{})

func UnauthorizedResponse

func UnauthorizedResponse(ctx *gin.Context, err error)

Types

type Authorization

type Authorization interface {
	Verify(claims jwt.Claims) bool
	GetEmptyMyClaims() jwt.Claims
}

type JwtOptions

type JwtOptions struct {
	Secret string
	Lookup string
	Auth   Authorization
}

type Response

type Response struct {
	Msg  string      `json:"msg"`
	Data interface{} `json:"data"`
}

type XHttp

type XHttp struct {
	Engine *gin.Engine
	// contains filtered or unexported fields
}

func NewXHttp

func NewXHttp() *XHttp

func (*XHttp) AddOnStartFunc

func (h *XHttp) AddOnStartFunc(fn []func())

func (*XHttp) AddOnStopFunc

func (h *XHttp) AddOnStopFunc(fn []func())

func (*XHttp) RegisterGlobalMiddleware

func (h *XHttp) RegisterGlobalMiddleware(middles []func(c *gin.Context))

func (*XHttp) Start

func (h *XHttp) Start()

type XJwt

type XJwt struct {
	Secret    []byte
	LookupKey string
	Auth      Authorization
}

func NewXJwt

func NewXJwt(options JwtOptions) *XJwt

func (*XJwt) GenerateToken

func (j *XJwt) GenerateToken(claims jwt.Claims) (sign string, err error)

func (*XJwt) Middleware

func (j *XJwt) Middleware(exception map[string]byte) gin.HandlerFunc