response

Documentation

Index

• Constants
• func Error(ctx *gin.Context, code string)
• func ErrorWithMsg(ctx *gin.Context, code string, msg string)
• func New(ctx *gin.Context, httpCode int, code string, msg string, data any)
• func Success(ctx *gin.Context, data any)
• type Response

Constants

const (
	CodeSuccess      = "00000"
	CodeNotFound     = "B0001"
	CodeParamsError  = "B0002"
	CodeNotLogin     = "B1001"
	CodeNoPermission = "B1002"
	CodeBanned       = "B1003"
	CodeServerError  = "A0001"

	MessageSuccess      = "success"
	MessageNotFound     = "not found"
	MessageParamsError  = "params error"
	MessageNotLogin     = "not login"
	MessageNoPermission = "no permission"
	MessageServerError  = "server error"
	MessageBanned       = "your account has been banned"

	MessageUnknown = "unknown error"
)

Functions

func Error

func Error(ctx *gin.Context, code string)

func ErrorWithMsg

func ErrorWithMsg(ctx *gin.Context, code string, msg string)

func New

func New(ctx *gin.Context, httpCode int, code string, msg string, data any)

func Success

func Success(ctx *gin.Context, data any)

Types

type Response

type Response struct {
	Code    string `json:"code"`
	Message string `json:"message"`
	Data    any    `json:"data"`
}