api

Documentation

Index

• type Api
  • func NewApi(s Service) *Api
  • func (a *Api) Get(c *gin.Context, req, data interface{})
  • func (a *Api) GetHandleFunc(req, data interface{}) func(*gin.Context)
  • func (a *Api) Insert(c *gin.Context, req interface{})
  • func (a *Api) InsertHandleFunc(req interface{}) func(*gin.Context)
  • func (a *Api) JSON(c *gin.Context, resp interface{})
  • func (a *Api) List(c *gin.Context, req, data interface{})
  • func (a *Api) ListHandleFunc(req, data interface{}) func(*gin.Context)
  • func (a *Api) Remove(c *gin.Context, req interface{})
  • func (a *Api) RemoveHandleFunc(req interface{}) func(*gin.Context)
  • func (a *Api) Removes(c *gin.Context, req interface{})
  • func (a *Api) RemovesHandleFunc(req interface{}) func(*gin.Context)
  • func (a *Api) ShouldBindJSON(c *gin.Context, req interface{}) bool
  • func (a *Api) ShouldBindQuery(c *gin.Context, req interface{}) bool
  • func (a *Api) Status(c *gin.Context, req interface{})
  • func (a *Api) StatusHandleFunc(req interface{}) func(*gin.Context)
  • func (a *Api) Update(c *gin.Context, req interface{})
  • func (a *Api) UpdateHandleFunc(req interface{}) func(*gin.Context)
• type Service
• type UserApi
  • func NewUserApi() *UserApi
  • func (u *UserApi) Get(c *gin.Context)
  • func (u *UserApi) Insert(c *gin.Context)
  • func (u *UserApi) List(c *gin.Context)
  • func (u *UserApi) Login(c *gin.Context)
  • func (u *UserApi) Remove(c *gin.Context)
  • func (u *UserApi) Removes(c *gin.Context)
  • func (u *UserApi) Status(c *gin.Context)
  • func (u *UserApi) Update(c *gin.Context)

Types

type Api

type Api struct {
	Svc Service
}

func NewApi

func NewApi(s Service) *Api

func (*Api) Get

func (a *Api) Get(c *gin.Context, req, data interface{})

func (*Api) GetHandleFunc

func (a *Api) GetHandleFunc(req, data interface{}) func(*gin.Context)

func (*Api) Insert

func (a *Api) Insert(c *gin.Context, req interface{})

func (*Api) InsertHandleFunc

func (a *Api) InsertHandleFunc(req interface{}) func(*gin.Context)

func (*Api) JSON

func (a *Api) JSON(c *gin.Context, resp interface{})

func (*Api) List

func (a *Api) List(c *gin.Context, req, data interface{})

func (*Api) ListHandleFunc

func (a *Api) ListHandleFunc(req, data interface{}) func(*gin.Context)

func (*Api) Remove

func (a *Api) Remove(c *gin.Context, req interface{})

func (*Api) RemoveHandleFunc

func (a *Api) RemoveHandleFunc(req interface{}) func(*gin.Context)

func (*Api) Removes

func (a *Api) Removes(c *gin.Context, req interface{})

func (*Api) RemovesHandleFunc

func (a *Api) RemovesHandleFunc(req interface{}) func(*gin.Context)

func (*Api) ShouldBindJSON

func (a *Api) ShouldBindJSON(c *gin.Context, req interface{}) bool

func (*Api) ShouldBindQuery

func (a *Api) ShouldBindQuery(c *gin.Context, req interface{}) bool

func (*Api) Status

func (a *Api) Status(c *gin.Context, req interface{})

func (*Api) StatusHandleFunc

func (a *Api) StatusHandleFunc(req interface{}) func(*gin.Context)

func (*Api) Update

func (a *Api) Update(c *gin.Context, req interface{})

func (*Api) UpdateHandleFunc

func (a *Api) UpdateHandleFunc(req interface{}) func(*gin.Context)

type Service

type Service interface {
	Get(req, data interface{}) *contexts.RESPONSE
	List(req, data interface{}) *contexts.RESPONSEWITHCOUNT
	Insert(req interface{}) *contexts.RESPONSE
	Update(req interface{}) *contexts.RESPONSE
	Remove(req interface{}) *contexts.RESPONSE
}

type UserApi

type UserApi struct {
	*Api
	Svc *service.UserService
}

func NewUserApi

func NewUserApi() *UserApi

func (*UserApi) Get

func (u *UserApi) Get(c *gin.Context)

获取用户信息 @Summary 获取用户信息接口 @Schemes http https @Description 用于获取用户信息 @Tags 用户相关 @Produce json @param id query uint true "用户ID" @param Authorization header string true "授权令牌" @Response 200 {object} contexts.RESPONSE{Data=contexts.UserData} @Router /api/user/get [get]

func (*UserApi) Insert

func (u *UserApi) Insert(c *gin.Context)

新增用户信息 @Summary 新增用户信息接口 @Schemes http https @Description 用于新增用户信息 @Tags 用户相关 @Produce json @param object body contexts.UserInsertRequest true "用户信息" @param Authorization header string true "授权令牌" @Response 200 {object} contexts.RESPONSE @Router /api/user/insert [post]

func (*UserApi) List

func (u *UserApi) List(c *gin.Context)

获取用户列表 @Summary 获取用户列表接口 @Schemes http https @Description 用于获取用户列表 @Tags 用户相关 @Produce json @param account query string false "账户" @param status query int false "状态 1:启用 2:禁用 默认:1" @param page query uint64 false "页数 默认:1" @param limit query uint64 false "页数量 默认:20" @param Authorization header string true "授权令牌" @Response 200 {object} contexts.RESPONSE{Data=[]contexts.UserData{}} @Router /api/user/list [get]

func (*UserApi) Login

func (u *UserApi) Login(c *gin.Context)

登录 @Summary 登录接口 @Schemes http https @Description 用于登录admin @Tags 用户相关 @Accept json @Produce json @param object body contexts.UserLoginRequest true "登录参数" @Response 200 {object} contexts.UserLoginResponse @Router /api/user/login [post]

func (*UserApi) Remove

func (u *UserApi) Remove(c *gin.Context)

删除用户 @Summary 删除用户接口 @Schemes http https @Description 用于删除用户 @Tags 用户相关 @Produce json @param object body contexts.RemoveRequest true "用户id信息" @param Authorization header string true "授权令牌" @Response 200 {object} contexts.RESPONSE @Router /api/user/remove [post]

func (*UserApi) Removes

func (u *UserApi) Removes(c *gin.Context)

批量删除用户 @Summary 批量删除用户接口 @Schemes http https @Description 用于批量删除用户 @Tags 用户相关 @Produce json @param object body contexts.RemovesRequest true "用户ids信息" @param Authorization header string true "授权令牌" @Response 200 {object} contexts.RESPONSE @Router /api/user/removes [post]

func (*UserApi) Status

func (u *UserApi) Status(c *gin.Context)

更新用户状态 @Summary 更新用户状态接口 @Schemes http https @Description 用于更新用户状态 @Tags 用户相关 @Produce json @param object body contexts.StatusRequest true "用户状态信息" @param Authorization header string true "授权令牌" @Response 200 {object} contexts.RESPONSE @Router /api/user/status [post]

func (*UserApi) Update

func (u *UserApi) Update(c *gin.Context)

更新用户信息 @Summary 更新用户信息接口 @Schemes http https @Description 用于更新用户信息 @Tags 用户相关 @Produce json @param object body contexts.UserUpdateRequest true "用户信息" @param Authorization header string true "授权令牌" @Response 200 {object} contexts.RESPONSE @Router /api/user/update [post]