https

Documentation

Index

• Constants
• type Error
  • func NewBadRequestError(format string, a ...any) *Error
  • func NewError(code int, message string) *Error
  • func NewInternalError(format string, a ...any) *Error
  • func NewNotFoundError(format string, a ...any) *Error
  • func (e *Error) Error() string
• type Handler
  • func (h Handler) Handler() Handler
  • func (h Handler) MethodName() string
• type IHandler
• type Response
• type RouterGroup
  • func NewRouterGroup(ginGR *gin.RouterGroup) *RouterGroup
  • func (rg *RouterGroup) GET(relativePath string, handler IHandler)
  • func (rg *RouterGroup) Group(relativePath string, handlers ...gin.HandlerFunc) *RouterGroup
• type SubError

Constants

const (
	CTXHandlerKey = "_CTX_Handler"
)

const (
	CodeOk = 20000
)

const (
	CtxResponseKey = "_CTX_RESPONSE"
)

const (
	HTTPHeaderFrom = "X-SP-METADATA-HTTP-FROM"
)

Types

type Error

type Error struct {
	Code    int        `json:"code"`
	Message string     `json:"message"`
	Errors  []SubError `json:"errors,omitempty"`
}

func NewBadRequestError

func NewBadRequestError(format string, a ...any) *Error

func NewError

func NewError(code int, message string) *Error

func NewInternalError

func NewInternalError(format string, a ...any) *Error

func NewNotFoundError

func NewNotFoundError(format string, a ...any) *Error

func (*Error) Error

func (e *Error) Error() string

type Handler

type Handler func(*gin.Context) (resp interface{}, err *Error)

func (Handler) Handler

func (h Handler) Handler() Handler

func (Handler) MethodName

func (h Handler) MethodName() string

type IHandler

type IHandler interface {
	Handler() Handler
	MethodName() string
}

type Response

type Response struct {
	Error *Error      `json:"error,omitempty"`
	Data  interface{} `json:"data,omitempty"`
}

https://google.github.io/styleguide/jsoncstyleguide.xml#JSON_Structure_&_Reserved_Property_Names

type RouterGroup

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

func NewRouterGroup

func NewRouterGroup(ginGR *gin.RouterGroup) *RouterGroup

func (*RouterGroup) GET

func (rg *RouterGroup) GET(relativePath string, handler IHandler)

func (*RouterGroup) Group

func (rg *RouterGroup) Group(relativePath string, handlers ...gin.HandlerFunc) *RouterGroup

type SubError

type SubError struct {
	Domain  string `json:"domain"`
	Reason  string `json:"reason"`
	Message string `json:"message"`
}