apis

Documentation

Index

• func Fail(c *gin.Context, code int, args ...interface{})
• func Ok(c *gin.Context, args ...interface{})
• func Out(c *gin.Context, code int, args ...interface{})
• func Register(name string, sf Strapper)
• func Routers(r gin.IRouter, names ...string)
• type Error
  • func GetError(r *http.Request, code int, err interface{}, args ...interface{}) Error
• type FieldError
• type IError
• type StrapFunc
  • func (f StrapFunc) Strap(r gin.IRouter)
• type Strapper

Functions

func Fail

func Fail(c *gin.Context, code int, args ...interface{})

Fail response fail with code, err, field

func Ok

func Ok(c *gin.Context, args ...interface{})

Ok ...

func Out

func Out(c *gin.Context, code int, args ...interface{})

Out ...

func Register

func Register(name string, sf Strapper)

Register ...

func Routers

func Routers(r gin.IRouter, names ...string)

Routers ...

Types

type Error

type Error struct {
	Code    int    `json:"code" description:"错误代码"`
	Message string `json:"message,required" description:"错误信息"`
	Field   string `json:"field,omitempty" description:"错误字段,可选,多用于表单校验"`
}

Error ...

func GetError

func GetError(r *http.Request, code int, err interface{}, args ...interface{}) Error

type FieldError

type FieldError interface {
	Field() string
}

FieldError ...

type IError

type IError interface {
	GetCode() int
	GetMessage() string
	GetField() string
}

IError ...

type StrapFunc

type StrapFunc func(r gin.IRouter)

StrapFunc ...

func (StrapFunc) Strap

func (f StrapFunc) Strap(r gin.IRouter)

Strap ...

type Strapper

type Strapper interface {
	Strap(r gin.IRouter)
}

Strapper ...