rest

Documentation

Index

• Constants
• Variables
• func Failed(c *gin.Context, err error)
• func GenericReq[T any](context *gin.Context, handler func(receive T) (interface{}, error))
• func RegisterHandler(engine gin.IRouter, rootPath string, handler Handler)
• func Response(c *gin.Context, result Result)
• func SimpleReq(context *gin.Context, handler func() (interface{}, error))
• func Success(c *gin.Context, data interface{})
• type Check
• type Handler
• type HttpError
  • func CodeError(err error, code int) HttpError
  • func NewHttpError(err error, code int, httpStatus int) HttpError
  • func StatusError(err error, httpStatus int) HttpError
  • func (e HttpError) Error() string
• type Result
  • func NewResult(code int, data interface{}, err error, status int) Result
• type Route
• type Router
  • func (router Router) RegisterHandler(engine gin.IRouter)

Constants

const (
	CodeUnknown        = -1
	CodeSuccess        = 0
	CodeBindJsonFailed = 1
	CodePreCheckFailed = 2
)

Variables

var ErrFunc func(err error)

Functions

func Failed

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

func GenericReq

func GenericReq[T any](context *gin.Context, handler func(receive T) (interface{}, error))

func RegisterHandler

func RegisterHandler(engine gin.IRouter, rootPath string, handler Handler)

func Response

func Response(c *gin.Context, result Result)

func SimpleReq

func SimpleReq(context *gin.Context, handler func() (interface{}, error))

func Success

func Success(c *gin.Context, data interface{})

Types

type Check

type Check interface {
	Check() (bool, string)
}

type Handler

type Handler interface {
	Routes() []Route
}

type HttpError

type HttpError struct {
	Err        error `json:"-"`
	Code       int   `json:"code"`
	HttpStatus int   `json:"-"`
}

func CodeError

func CodeError(err error, code int) HttpError

func NewHttpError

func NewHttpError(err error, code int, httpStatus int) HttpError

func StatusError

func StatusError(err error, httpStatus int) HttpError

func (HttpError) Error

func (e HttpError) Error() string

type Result

type Result struct {
	Err        error       `json:"-"`
	Code       int         `json:"code"`
	HttpStatus int         `json:"-"`
	Data       interface{} `json:"data,omitempty"`
	Message    string      `json:"message,omitempty"`
}

func NewResult

func NewResult(code int, data interface{}, err error, status int) Result

type Route

type Route struct {
	Method  string
	Path    string
	Handler func(context *gin.Context)
}

type Router

type Router struct {
	RootPath string
	Routes   []Route
}

func (Router) RegisterHandler

func (router Router) RegisterHandler(engine gin.IRouter)