http

Documentation

Index

• func GetCaptcha(ctx *gin.Context)
• type AuthController
  • func NewAuthController(di *dig.Container, l v1log.ILog, conf *configstc.UserAppConfig) *AuthController
  • func (ctr *AuthController) AuthByQQ(ctx *gin.Context)
  • func (ctr *AuthController) AuthByWxCode(ctx *gin.Context)
  • func (ctr *AuthController) AuthFreshToken(ctx *gin.Context)
  • func (ctr *AuthController) AuthInfo(ctx *gin.Context)
  • func (ctr *AuthController) AuthLogin(ctx *gin.Context)
  • func (ctr *AuthController) AuthLogout(ctx *gin.Context)
  • func (ctr *AuthController) DebugAuthByThird(ctx *gin.Context)
  • func (ctr *AuthController) SignUp(ctx *gin.Context)
• type UserController
  • func NewUserController(di *dig.Container, l v1log.ILog, conf *configstc.UserAppConfig) *UserController
  • func (ctr *UserController) BindEmailPhone(ctx *gin.Context)
  • func (ctr *UserController) LoginRecord(ctx *gin.Context)
  • func (ctr *UserController) ModifyInfo(ctx *gin.Context)
  • func (ctr *UserController) ModifyPassword(ctx *gin.Context)
  • func (ctr *UserController) ResetPassword(ctx *gin.Context)
• type UserManageController
  • func NewUserManageController(di *dig.Container, l v1log.ILog, conf *configstc.UserAppConfig) *UserManageController
  • func (ctr *UserManageController) DeleteUser(ctx *gin.Context)
  • func (ctr *UserManageController) DisableUser(ctx *gin.Context)
  • func (ctr *UserManageController) QueryUser(ctx *gin.Context)
  • func (ctr *UserManageController) ResetUserPassword(ctx *gin.Context)
  • func (ctr *UserManageController) SaveUser(ctx *gin.Context)
  • func (ctr *UserManageController) SearchUser(ctx *gin.Context)
• type VerifyCodeController
  • func NewVerifyCodeController(di *dig.Container, l v1log.ILog, conf *configstc.UserAppConfig) *VerifyCodeController
  • func (ctr *VerifyCodeController) SendCode(ctx *gin.Context)
  • func (ctr *VerifyCodeController) VerifyCode(ctx *gin.Context)
  • func (ctr *VerifyCodeController) VerifyHandler() gin.HandlerFunc

Functions

func GetCaptcha

func GetCaptcha(ctx *gin.Context)

GetCaptcha godoc @Summary 验证码图片 @Description 验证码生成图片 @Tags user.other @Produce json @success 0 {object} respdata.ResponseData{data=respdata.CaptchaResponse} "获取成功" @failure 1 {object} respdata.ResponseData{code=int} "获取失败" @Router /captcha/get [post]

Types

type AuthController

type AuthController struct {
	*gin_http.I18nController
	passwd.SaltMd5Password
	// contains filtered or unexported fields
}

func NewAuthController

func NewAuthController(di *dig.Container, l v1log.ILog, conf *configstc.UserAppConfig) *AuthController

func (*AuthController) AuthByQQ

func (ctr *AuthController) AuthByQQ(ctx *gin.Context)

AuthByQQ godoc @Summary Auth-QQ授权登录 @Description 第三方登录-QQ @Tags user.auth @Produce json @Param param body reqdata.ThirdAuthReq true "第三方授权码" @success 200 {object} respdata.ResponseData{data=respdata.AuthResp} "授权成功" @success 500 {object} respdata.ResponseData{} "授权失败" @Router /auth/qq_code [post] @x-response-apikey-token-set {"tokenKey":"response.data.token","apiKey":"ApiKeyAuth"}

func (*AuthController) AuthByWxCode

func (ctr *AuthController) AuthByWxCode(ctx *gin.Context)

AuthByWxCode godoc @Summary Auth-微信code授权 @Description 第三方登录-微信 @Tags user.auth @Produce json @Param param body reqdata.ThirdAuthReq true "第三方授权码" @success 200 {object} respdata.ResponseData{data=respdata.AuthResp} "授权成功" @success 500 {object} respdata.ResponseData{} "授权失败" @Router /auth/wechat_code [post] @x-response-apikey-token-set {"tokenKey":"response.data.token","apiKey":"ApiKeyAuth"}

func (*AuthController) AuthFreshToken

func (ctr *AuthController) AuthFreshToken(ctx *gin.Context)

AuthFreshToken godoc @Summary Auth-刷新授权 @Description 刷新授权token @Tags user.auth @Produce json @Security ApiKeyAuth @success 200 {object} respdata.ResponseData{data=respdata.AuthResp} "刷新成功" @success 500 {object} respdata.ResponseData{} "刷新失败" @Router /auth/fresh_token [post] @x-response-apikey-token-set {"tokenKey":"response.data.token","apiKey":"ApiKeyAuth"}

func (*AuthController) AuthInfo

func (ctr *AuthController) AuthInfo(ctx *gin.Context)

AuthInfo godoc @Summary Auth-登录信息 @Description 获取登录信息 @Tags user.auth @Security ApiKeyAuth @Produce json @success 200 {object} respdata.ResponseData{data=respdata.AuthResp} "授权信息" @Router /auth/info [post]

func (*AuthController) AuthLogin

func (ctr *AuthController) AuthLogin(ctx *gin.Context)

AuthLogin godoc @Summary Auth-授权登录 @Description 登录 @Tags user.auth @Produce json @Param param body reqdata.AuthReq true "账户信息" @success 200 {object} respdata.ResponseData{data=respdata.AuthResp} "授权成功" @success 500 {object} respdata.ResponseData{} "授权失败" @Router /auth/login [post] @x-response-apikey-token-set {"tokenKey":"response.data.token","apiKey":"ApiKeyAuth"}

func (*AuthController) AuthLogout

func (ctr *AuthController) AuthLogout(ctx *gin.Context)

AuthLogout godoc @Summary Auth-取消授权 @Description 取消授权 @Tags user.auth @Produce json @Security ApiKeyAuth @success 200 {object} respdata.ResponseData{} "取消成功" @success 500 {object} respdata.ResponseData{} "取消失败" @Router /auth/logout [post]

func (*AuthController) DebugAuthByThird

func (ctr *AuthController) DebugAuthByThird(ctx *gin.Context)

DebugAuthByThird godoc @Summary [DEBUG]第三方授权 @Description 第三方登录-微信 @Tags user.auth @Produce json @success 200 {object} respdata.ResponseData{data=respdata.AuthResp} "授权成功" @success 500 {object} respdata.ResponseData{code} "授权失败" @Router /debug/auth/third [post] @x-response-apikey-token-set {"tokenKey":"response.data.token","apiKey":"ApiKeyAuth"}

func (*AuthController) SignUp

func (ctr *AuthController) SignUp(ctx *gin.Context)

SignUp godoc @Summary 注册账户 @Description 注册账户（账户/密码） @Tags user.auth @Accept json @Produce json @Param param body reqdata.RegisterReq true "注册信息" @success 0 {object} respdata.ResponseData{} "注册成功" @success 500 {object} respdata.ResponseData{} "授权失败" @Router /auth/register [post]

type UserController

type UserController struct {
	*gin_http.CaptchaController
	*gin_http.I18nController
	passwd.SaltMd5Password
	// contains filtered or unexported fields
}

func NewUserController

func NewUserController(di *dig.Container, l v1log.ILog, conf *configstc.UserAppConfig) *UserController

func (*UserController) BindEmailPhone

func (ctr *UserController) BindEmailPhone(ctx *gin.Context)

BindEmailPhone godoc @Summary 用户中心-绑定邮箱/手机 @Description 绑定邮箱/手机 @Tags user @Produce json @Security ApiKeyAuth @Param param body reqdata.PhoneEmailVerifyReq true "验证信息" @success 200 {object} respdata.ResponseData{} "绑定成功" @success 500 {object} respdata.ResponseData{} "绑定失败" @Router /u_center/bind [post]

func (*UserController) LoginRecord

func (ctr *UserController) LoginRecord(ctx *gin.Context)

LoginRecord godoc @Summary 用户中心-历史登录记录 @Description 登录历史记录 @Tags user @Produce json @Security ApiKeyAuth @Param param body reqdata.SearchLoginRecordReq true "搜索参数集" @success 200 {object} respdata.ResponseData{data=respdata.SearchListResponse{list=[]models.UserLoginRecord}} "获取成功" @success 500 {object} respdata.ResponseData{} "授权失败" @Router /u_center/login_record [post]

func (*UserController) ModifyInfo

func (ctr *UserController) ModifyInfo(ctx *gin.Context)

ModifyInfo godoc @Summary 用户中心-修改个人信息 @Description 修改个人信息 @Tags user @Produce json @Security ApiKeyAuth @Param param body reqdata.ModifyInfoReq true "账户信息" @success 200 {object} respdata.ResponseData{} "授权成功" @success 500 {object} respdata.ResponseData{} "授权失败" @Router /u_center/modify_info [post]

func (*UserController) ModifyPassword

func (ctr *UserController) ModifyPassword(ctx *gin.Context)

ModifyPassword godoc @Summary 用户中心-修改密码 @Description 授权登录后修改密码 @Tags user @Produce json @Security ApiKeyAuth @Param param body reqdata.ModifyPasswordReq true "修改密码" @success 0 {object} respdata.ResponseData{} "修改成功" @fail 1 {object} respdata.ResponseData{} "修改失败" @Router /u_center/modify_pwd [post]

func (*UserController) ResetPassword

func (ctr *UserController) ResetPassword(ctx *gin.Context)

ResetPassword godoc @Summary 忘记密码 @Description 忘记密码场景下重置密码 @Tags user @Produce json @Param param body reqdata.ResetPasswordReq true "重置密码" @success 0 {object} respdata.ResponseData{} "重置成功" @fail 1 {object} respdata.ResponseData{} "重置失败" @Router /u_center/reset_pwd [post]

type UserManageController

type UserManageController struct {
	passwd.SaltMd5Password
	gin_http.ResponseController
	gin_http.OperateLogController
	// contains filtered or unexported fields
}

func NewUserManageController

func NewUserManageController(di *dig.Container, l v1log.ILog, conf *configstc.UserAppConfig) *UserManageController

func (*UserManageController) DeleteUser

func (ctr *UserManageController) DeleteUser(ctx *gin.Context)

DeleteUser godoc @Summary 用户管理-删除用户 @Description 删除指定用户 @Tags admin.user @Security AdminKeyAuth @Produce json @Param param body reqdata.DetailReq true "指定用户id" @success 0 {object} respdata.ResponseData{} "成功" @Router /mag/user/delete [post]

func (*UserManageController) DisableUser

func (ctr *UserManageController) DisableUser(ctx *gin.Context)

DisableUser godoc @Summary 用户管理-启用/禁用 @Description 操作启用/禁用用户 @Security AdminKeyAuth @Tags admin.user @Accept json @Produce json @Param param body disableStatusReq true "状态设置请求" @success 200 {object} respdata.ResponseData{} "设置成功" @Router /mag/user/disable [post]

func (*UserManageController) QueryUser

func (ctr *UserManageController) QueryUser(ctx *gin.Context)

QueryUser godoc @Summary 用户管理-详情 @Description 查询单个用户的详细信息 @Tags admin.user @Security AdminKeyAuth @Produce json @Param param body reqdata.DetailReq true "查询指定id详情" @success 0 {object} respdata.ResponseData{data=respdata.QueryUserResp} "获取成功" @success 2 {object} respdata.ResponseData{} "系统繁忙" @success 4 {object} respdata.ResponseData{} "参数无效" @success 10 {object} respdata.ResponseData{} "未查询到" @Router /mag/user/detail [post]

func (*UserManageController) ResetUserPassword

func (ctr *UserManageController) ResetUserPassword(ctx *gin.Context)

ResetUserPassword godoc @Summary 用户管理-重置密码 @Description 密码重置 @Security AdminKeyAuth @Tags admin.user @Accept json @Produce json @Param param body reqdata.ResetUserPasswdReq true "重置密码请求" @success 200 {object} respdata.ResponseData{} "成功" @Router /mag/user/reset_password [post]

func (*UserManageController) SaveUser

func (ctr *UserManageController) SaveUser(ctx *gin.Context)

SaveUser godoc @Summary 用户管理-保存 @Description 创建或编辑用户 @Tags admin.user @Security AdminKeyAuth @Produce json @Param param body reqdata.AddEditUserReq true "提交用户信息" @success 0 {object} respdata.ResponseData{data=respdata.DetailResp} "保存成功" @success 2 {object} respdata.ResponseData{} "系统繁忙" @success 4 {object} respdata.ResponseData{} "参数无效" @success 10 {object} respdata.ResponseData{} "未查询到" @Router /mag/user/save [post]

func (*UserManageController) SearchUser

func (ctr *UserManageController) SearchUser(ctx *gin.Context)

SearchUser 用户列表 godoc @Summary 用户管理-列表 @Description 用户列表展示和搜索 @Tags admin.user @Security AdminKeyAuth @Produce json @Param param body reqdata.SearchUserParam true "搜索参数集" @success 0 {object} respdata.ResponseData{data=respdata.SearchListResponse{list=[]models.User}} "获取成功" @Router /mag/user/search [post]

type VerifyCodeController

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

func NewVerifyCodeController

func NewVerifyCodeController(di *dig.Container, l v1log.ILog, conf *configstc.UserAppConfig) *VerifyCodeController

func (*VerifyCodeController) SendCode

func (ctr *VerifyCodeController) SendCode(ctx *gin.Context)

SendCode godoc @Summary 短信验证码-发送 @Description 发送短信验证码 @Tags user.other @Produce json @Security ApiKeyAuth @Param param body reqdata.PhoneEmailSendReq true "发送对象信息" @success 200 {object} respdata.ResponseData{data=respdata.SmsCodeSendResp} "发送成功" @success 500 {object} respdata.ResponseData{} "发送失败" @Router /verify_code/send [post]

func (*VerifyCodeController) VerifyCode

func (ctr *VerifyCodeController) VerifyCode(ctx *gin.Context)

VerifyCode godoc @Summary 短信验证码-校验 @Description 校验短信验证码 @Tags user.other @Produce json @Security ApiKeyAuth @Param param body reqdata.PhoneEmailVerifyReq true "验证信息" @success 0 {object} respdata.ResponseData{data=respdata.SmsCodeVerifyResp} "验证成功" @success 5 {object} respdata.ResponseData{} "验证失败" @Router /verify_code/verify [post]

func (*VerifyCodeController) VerifyHandler

func (ctr *VerifyCodeController) VerifyHandler() gin.HandlerFunc