response

Documentation

Index

• Variables
• func Abort(c *gin.Context, err Error)
• func Err(c *gin.Context, err Error)
• func JSON(c *gin.Context, code Code, message string, data interface{})
• func OK(c *gin.Context, message string, data interface{})
• type APIModel
  • func NewAPIModel(code Code, message string, data interface{}) *APIModel
• type Code
• type Error
  • func (e Error) Error() string
• type PageModel

Variables

var (
	UnknownError = func(detail string) Error {
		return Error{Code: CodeUnknown, Msg: "unknown error", Detail: detail}
	}

	DBConnectError = func(detail string) Error {
		return Error{Code: CodeDBConnect, Msg: "database connection error", Detail: detail}
	}

	DBOperationError = func(detail string) Error {
		return Error{Code: CodeDBOperation, Msg: "database operation error", Detail: detail}
	}

	RequestParamError = func(detail string) Error {
		return Error{Code: CodeRequestParam, Msg: "request param error", Detail: detail}
	}

	TokenInvalidError = func(detail string) Error {
		return Error{Code: CodeTokenInvalid, Msg: "token invalid error", Detail: detail}
	}

	PermissionDeniedError = func(detail string) Error {
		return Error{Code: CodePermissionDenied, Msg: "permission denied error", Detail: detail}
	}
)

System error

var (
	EmptyMapData = func() map[string]interface{} {
		return make(map[string]interface{})
	}

	EmptyArrayData = func() []interface{} {
		return make([]interface{}, 0)
	}
)

Empty Data

Functions

func Abort

func Abort(c *gin.Context, err Error)

Abort response abort

func Err

func Err(c *gin.Context, err Error)

Err response error

func JSON

func JSON(c *gin.Context, code Code, message string, data interface{})

JSON response APIModel

func OK

func OK(c *gin.Context, message string, data interface{})

OK response OK

Types

type APIModel

type APIModel struct {
	Code    Code        `json:"code"`
	Data    interface{} `json:"data"`
	Message string      `json:"message"`
}

APIModel api response model

func NewAPIModel

func NewAPIModel(code Code, message string, data interface{}) *APIModel

NewAPIModel new api response

type Code

type Code int

Code response code

const (
	CodeOK Code = 0

	CodeUnknown      Code = 10000
	CodeDBConnect    Code = 10001
	CodeDBOperation  Code = 10002
	CodeRequestParam Code = 10003

	CodeTokenInvalid     Code = 20101
	CodePermissionDenied Code = 20102
)

Code

type Error

type Error struct {
	Code   Code   `json:"code"`
	Msg    string `json:"msg"`
	Detail string `json:"detail"`
}

Error error

func (Error) Error

func (e Error) Error() string

type PageModel

type PageModel struct {
	List       interface{} `json:"list"`
	Number     int         `json:"pageNumber"`
	Size       int         `json:"pageSize"`
	TotalCount int         `json:"totalCount"`
}

PageModel page response model