api

Documentation

Index

• Variables
• type AuthHandler
  • func NewAuthHandler(cfg *conf.Config, jwtSrv *lib.JwtService, userSrv *lib.UserService) *AuthHandler
  • func (h *AuthHandler) RenewToken(c *gin.Context)
  • func (h *AuthHandler) SignIn(c *gin.Context)
  • func (h *AuthHandler) SignUp(c *gin.Context)
• type UserHandler
  • func NewUserHandler(userSrv *lib.UserService) *UserHandler
  • func (h *UserHandler) GetUserInfo(c *gin.Context)

Variables

var ApiSet = wire.NewSet(NewAuthHandler, NewUserHandler)

ApiSet 为api providers

Types

type AuthHandler

type AuthHandler struct {
	// contains filtered or unexported fields
}

AuthHander 用户认证处理器

func NewAuthHandler

func NewAuthHandler(cfg *conf.Config, jwtSrv *lib.JwtService, userSrv *lib.UserService) *AuthHandler

NewAuthHandler 创建新的AuthHandler

func (*AuthHandler) RenewToken

func (h *AuthHandler) RenewToken(c *gin.Context)

@Summary "RenewToken" @Description "更新Token" @Tags auth @Produce application/json @Param category query bool false "人员类别: manager: true | user: false" @response default {object} response.Response "响应包装" @Success 200 {object} lib.TokenOutput "更新成功, 如果data为空, 表示token已更新过" @Router /auth/renewToken [get]

func (*AuthHandler) SignIn

func (h *AuthHandler) SignIn(c *gin.Context)

@Summary "SignIn" @Description "用户登录" @Tags auth @Accept application/json @Produce application/json @Param phone query string true "手机号" @Param password query string true "用户密码" @Param category query bool false "人员类别: manager: true | user: false" @response default {object} response.Response "响应包装" @Success 200 {object} loginResponse "登录成功后response中的data数据" @Router /auth/signin [get]

func (*AuthHandler) SignUp

func (h *AuthHandler) SignUp(c *gin.Context)

@Summary "SignUp" @Description "用户注册" @Tags auth @Accept application/json @Produce application/json @Param name formData string true "用户名" @Param phone formData string true "手机号" @Param password formData string true "用户密码" @Param category formData bool false "人员类别: manager: true | user: false" @response default {object} response.Response "响应包装" @Success 200 {object} model.User '用户详情' @Router /auth/signup [post]

type UserHandler

type UserHandler struct {
	// contains filtered or unexported fields
}

UserHandler 用户处理器

func NewUserHandler

func NewUserHandler(userSrv *lib.UserService) *UserHandler

NewUserHandler 创建用户处理器

func (*UserHandler) GetUserInfo

func (h *UserHandler) GetUserInfo(c *gin.Context)

@Summary 'GetUserInfo' @description '获取用户信息' @Tags user @Security ApiKeyAuth @Prodece application/json @response default {object} response.Response "响应包装" @Success 200 {object} model.User "用户信息" @Router /user/getUserInfo [get]