api

package

v0.6.0 Latest Latest Go to latest Published: Nov 23, 2024 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/doraemonkeys/doraemon

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func FailInternalError(c *gin.Context)
func FailWithMsg(c *gin.Context, msg string)
func Ok(c *gin.Context)
func OkWithData(c *gin.Context, data any)
func OkWithMsg(c *gin.Context, msg string)
type Body
type Status
- func (s Status) Send(c *gin.Context)
type StatusCode

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	StatusSuccess             = Status{Code: CodeSuccess, Msg: "success"}
	StatusInvalidParams       = Status{Code: CodeErrorInvalidParams, Msg: "invalid params"}
	StatusDatabase            = Status{Code: CodeErrorDatabase, Msg: "database error"}
	StatusUserNotExist        = Status{Code: CodeErrorUserNotExist, Msg: "user not exist"}
	StatusPassword            = Status{Code: CodeErrorPassword, Msg: "password error"}
	StatusTokenExpired        = Status{Code: CodeErrorTokenExpired, Msg: "token expired"}
	StatusUnauthorized        = Status{Code: CodeUnauthorized, Msg: "unauthorized"}
	StatusInternalServerError = Status{Code: CodeErrorInternalServerError, Msg: "internal server error"}
)

Functions ¶

func FailInternalError ¶

func FailInternalError(c *gin.Context)

func FailWithMsg ¶

func FailWithMsg(c *gin.Context, msg string)

func Ok ¶

func Ok(c *gin.Context)

func OkWithData ¶

func OkWithData(c *gin.Context, data any)

func OkWithMsg ¶

func OkWithMsg(c *gin.Context, msg string)

Types ¶

type Body ¶

type Body struct {
	Status
	Data any `json:"data"`
}

type Status ¶

type Status struct {
	Code StatusCode `json:"status"`
	Msg  string     `json:"msg"`
}

func (Status) Send ¶

func (s Status) Send(c *gin.Context)

type StatusCode ¶

type StatusCode int

const (
	CodeSuccess                  StatusCode = 1
	CodeError                    StatusCode = 0
	CodeErrorInvalidParams       StatusCode = 2001
	CodeErrorDatabase            StatusCode = 2002
	CodeErrorUserNotExist        StatusCode = 2003
	CodeErrorPassword            StatusCode = 2004
	CodeErrorTokenExpired        StatusCode = 2005
	CodeUnauthorized             StatusCode = 2006
	CodeErrorInternalServerError StatusCode = 2007
)

Source Files ¶

View all Source files

api.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL