baseapi

Documentation

Index

• type Api
  • func (a *Api) Bind(d interface{}, bindings ...binding.Binding) error
  • func (a *Api) DelUserFromSession(user model.SysUser) error
  • func (a *Api) ErrorResp() *Api
  • func (a *Api) ForbiddenResp() *Api
  • func (a *Api) GetUidFromSession() int
  • func (a *Api) GetUserFromSession() *model.SysUser
  • func (a *Api) MountCtx(c *gin.Context) *Api
  • func (a *Api) SetCode(code int) *Api
  • func (a *Api) SetCount(count int) *Api
  • func (a *Api) SetData(data interface{}) *Api
  • func (a *Api) SetLogTag(buType int, opTitle string) *Api
  • func (a *Api) SetMsg(msg string) *Api
  • func (a *Api) SetUserToSession(user model.SysUser) (string, error)
  • func (a *Api) SuccessResp() *Api
  • func (a *Api) TransErr(err error) string
  • func (a *Api) UnauthorizedResp() *Api
  • func (a *Api) WriteCustomJsonExit(data any)
  • func (a *Api) WriteHtmlExit(page string, data gin.H)
  • func (a *Api) WriteJsonExit()
  • func (a *Api) WriteRedirect(path string)
  • func (a *Api) WriteStringExit(format string, value ...any)
• type CaptchaResponse
• type CommonResp

Types

type Api

type Api struct {
	C *gin.Context
	// contains filtered or unexported fields
}

func (*Api) Bind

func (a *Api) Bind(d interface{}, bindings ...binding.Binding) error

Bind 参数校验

func (*Api) DelUserFromSession

func (a *Api) DelUserFromSession(user model.SysUser) error

DelUserFromSession

func (*Api) ErrorResp

func (a *Api) ErrorResp() *Api

ErrorResp 返回一个错误的消息体

func (*Api) ForbiddenResp

func (a *Api) ForbiddenResp() *Api

ForbiddenResp 返回一个拒绝访问的消息体

func (*Api) GetUidFromSession

func (a *Api) GetUidFromSession() int

GetUid 获得当前用户id

func (*Api) GetUserFromSession

func (a *Api) GetUserFromSession() *model.SysUser

GetProfile 获得用户信息详情

func (*Api) MountCtx

func (a *Api) MountCtx(c *gin.Context) *Api

MountCtx 挂载上下文

func (*Api) SetCode

func (a *Api) SetCode(code int) *Api

SetCode 设置消息体的编码

func (*Api) SetCount

func (a *Api) SetCount(count int) *Api

SetCount 设置消息体的业务类型

func (*Api) SetData

func (a *Api) SetData(data interface{}) *Api

SetData 设置消息体的数据

func (*Api) SetLogTag

func (a *Api) SetLogTag(buType int, opTitle string) *Api

SetLogTag 设置日志标识信息

func (*Api) SetMsg

func (a *Api) SetMsg(msg string) *Api

SetMsg 设置消息体的内容

func (*Api) SetUserToSession

func (a *Api) SetUserToSession(user model.SysUser) (string, error)

SetUserToSession

func (*Api) SuccessResp

func (a *Api) SuccessResp() *Api

SuccessResp 返回一个成功的消息体

func (*Api) TransErr

func (a *Api) TransErr(err error) string

TransErr 转换中文错误

func (*Api) UnauthorizedResp

func (a *Api) UnauthorizedResp() *Api

UnauthorizedResp 认证失败

func (*Api) WriteCustomJsonExit

func (a *Api) WriteCustomJsonExit(data any)

WriteCustomJsonExit 兼容个性化json写法

func (*Api) WriteHtmlExit

func (a *Api) WriteHtmlExit(page string, data gin.H)

WriteHtmlExit 输出Html页面

func (*Api) WriteJsonExit

func (a *Api) WriteJsonExit()

WriteJsonExit 输出json到客户端

func (*Api) WriteRedirect

func (a *Api) WriteRedirect(path string)

WriteRedirect 重定向

func (*Api) WriteStringExit

func (a *Api) WriteStringExit(format string, value ...any)

WriteStringExit 输出String

type CaptchaResponse

type CaptchaResponse struct {
	CaptchaId string `json:"captchaId"`
	PicPath   string `json:"picPath"`
}

type CommonResp

type CommonResp struct {
	Code  int         `json:"code"`  //响应编码: 200 成功 500 错误 403 无操作权限 401 鉴权失败  -1  失败
	Msg   string      `json:"msg"`   //消息内容
	Data  interface{} `json:"data"`  //数据内容
	Count int         `json:"count"` //数据数量
	Tag   bool        `json:"tag"`   //日志标记
	Type  int         `json:"type"`  //业务类型
	Title string      `json:"title"` //操作名称
}