usershandlers

Documentation

Index

• type FormalRegRequest
• type ListSearchUserResult
• type MatchUserByKeywordRequest
• type ModifyPasswordRequest
• type ModifyProfilesRequest
• type NormalRegRequest
• type UsernamePasswordLoginRequest
• type UsersHandlers
  • func (u *UsersHandlers) FormalRegister() gin.HandlerFunc
  • func (u *UsersHandlers) Info() gin.HandlerFunc
  • func (u *UsersHandlers) Login() gin.HandlerFunc
  • func (u *UsersHandlers) Match() gin.HandlerFunc
  • func (u *UsersHandlers) Modify() gin.HandlerFunc
  • func (u *UsersHandlers) ModifyPassword() gin.HandlerFunc
  • func (u *UsersHandlers) NormalReg() gin.HandlerFunc
  • func (u *UsersHandlers) Profile() gin.HandlerFunc
  • func (u *UsersHandlers) Search() gin.HandlerFunc

Types

type FormalRegRequest

type FormalRegRequest struct {
	// 用于正式注册的用户名
	//
	// required: true
	// min: 3
	Username string `json:"username"`
}

FormalRegRequest is SMS APIs

type ListSearchUserResult

type ListSearchUserResult struct {
	// 创建反馈的留言内容
	//
	// required: true
	// min: 6
	Keyword string `json:"keyword"`
	// pagination
	*basichandlers.PaginationRequest
}

ListSearchUserResult model swagger:model ListSearchUserResult

type MatchUserByKeywordRequest

type MatchUserByKeywordRequest struct {
	//用户名 用户名支持中国手机号和普通用户名
	//
	// required: true
	// min: 3
	Keyword string `json:"keyword"`
}

MatchUserByKeywordRequest Model

type ModifyPasswordRequest

type ModifyPasswordRequest struct {
	// 继承短信验证码校验
	// 用于发送短信的手机号码
	//
	// required: true
	// min: 11
	//
	// 发送短信的行为，注意：匹配操作类型将直接影响验证码模板
	// 如果不匹配的类型，虽然短信验证码发送成功，但可能依旧无法通过校验
	// 需保持与请求验证码时一致的action，否则将导致验证码校验无法通过
	//
	// required: true
	// min: 0
	//
	/// 验证码
	// 验证码将用于校验
	//
	// required: true
	// min: 4
	//
	//
	// Key 用于校验
	//
	// required: true
	// min: 4
	//
	*smshandlers.ValidateSMSCodeRequest
	//密码
	//
	// required: true
	// min: 6
	Password string `json:"password"`
}

ModifyPasswordRequest defined modify password request json bindings

type ModifyProfilesRequest

type ModifyProfilesRequest struct {
	// 昵称
	//
	// required: false
	// min: 11
	Nic interface{} `json:"nic"`
	// 介绍
	//
	// required: false
	// min: 0
	Bio interface{} `json:"bio"`
	// 性别
	//
	// required: false
	// min: 0
	Gender interface{} `json:"gender"`
}

ModifyProfilesRequest defined for Modify swagger:model SendSMSReq

type NormalRegRequest

type NormalRegRequest struct {
	// 继承短信验证码校验
	// 用于发送短信的手机号码
	//
	// required: true
	// min: 11
	//
	// 发送短信的行为，注意：匹配操作类型将直接影响验证码模板
	// 如果不匹配的类型，虽然短信验证码发送成功，但可能依旧无法通过校验
	// 需保持与请求验证码时一致的action，否则将导致验证码校验无法通过
	//
	// required: true
	// min: 0
	//
	/// 验证码
	// 验证码将用于校验
	//
	// required: true
	// min: 4
	//
	//
	// Key 用于校验
	//
	// required: true
	// min: 4
	//
	*smshandlers.ValidateSMSCodeRequest
	// 用于注册的账户名
	//
	// required: true
	// min: 3
	Username string `json:"username"`
	// 用于注册的密码
	//
	// required: true
	// min: 6
	Password string `json:"password"`
	// 用于注册的邮箱
	// 普通注册邮箱未非必选项目
	//
	// required: false
	// min: 5
	Email string `json:"email"`
	// 手机号
	//
	// required: true
	// min: 11
	Mobile string `json:"mobile"`

	// Type
	//
	// required: false
	// min: 1
	Type int `json:"type"`

	// 组织名称（组织名称不作为真实性校验项目，用户认证的组织查看users_verified）
	//
	// required: false
	// min: 1
	Orgname string `json:"orgname"`

	// 国家代码
	//
	// required: true
	// min: 1
	CountryCode string `json:"countryCode"`

	// 国家代码
	//
	// required: true
	// min: 1
	Language string `json:"language"`
}

NormalRegRequest defined normal user registry json bindings

type UsernamePasswordLoginRequest

type UsernamePasswordLoginRequest struct {
	//用户名 用户名支持中国手机号和普通用户名
	//
	// required: true
	// min: 3
	Username string `json:"username"`
	//密码
	//
	// required: true
	// min: 6
	Password string `json:"password"`
}

UsernamePasswordLoginRequest defined username and password authentication request json bindings

type UsersHandlers

type UsersHandlers struct {
	*basichandlers.Basic
}

UsersHandlers is defined for users api

func (*UsersHandlers) FormalRegister

func (u *UsersHandlers) FormalRegister() gin.HandlerFunc

FormalRegister defined user formal register API request @Summary 正式注册接口，用户更新用户短信登录时系统随机设置的用户名 @Tags 用户 @Description 正式注册接口仅供用户设置一次，一旦设置后，再次更新用户信息将会报错 @Accept json @Produce json @Accept application/x-json-stream @Param Authorization header string true "Authentication header" @Param FormalRegRequest body usershandlers.FormalRegRequest true "正式注册" @Success 200 "{"code":200,"data":{},"message":"操作成功"}" @Router /users/formalReg [post]

func (*UsersHandlers) Info

func (u *UsersHandlers) Info() gin.HandlerFunc

Info defined to get current user information @Summary 获取当前登录的用户信息 @Tags 用户 @Description 获取当前登录用户的信息 @Accept json @Produce json @Accept application/x-json-stream @Param Authorization header string true "Authentication header" @Success 200 "{"code":200,"data":{},"message":"操作成功"}" @Router /users/info [get]

func (*UsersHandlers) Login

func (u *UsersHandlers) Login() gin.HandlerFunc

Login defined username and password authentication API request 用户名密码登录 用户名密码登录时需要校验用户密码 TODO:用户密码输错大于5次时，将user.status 更新为3 ，对账号进行保护，强制用户必须修改密码后再登录 用户名密码登录校验用户状态 TODO:企业用户, 使用用户名密码登录需要发送登录通知短信

@Summary 使用用户名和密码登录 @Tags 用户 @Description 用户使用用户名密码登录 @Accept json @Produce json @Accept application/x-json-stream @Param UsernamePasswordLoginRequest body usershandlers.UsernamePasswordLoginRequest true "用户名密码登录" @Success 200 "{"code":200,"data":{},"message":"操作成功"}" @Router /users/login [post]

func (*UsersHandlers) Match

func (u *UsersHandlers) Match() gin.HandlerFunc

Match user by username or mobile number @Summary 查询用户注册 @Tags 用户 @Description 使用关键字查询用户是否注册可以是用户名，或者手机号 @Accept json @Produce json @Accept application/x-json-stream @Param MatchUserByKeywordRequest body usershandlers.MatchUserByKeywordRequest true "注册查询" @Success 200 "{"code":200,"data":{"registered": true},"message":"操作成功"}" @Router /users/match [post]

func (*UsersHandlers) Modify

func (u *UsersHandlers) Modify() gin.HandlerFunc

Modify defined for user profile modify @Summary 更新用户个人资料 @Tags 用户 @Description 根据选项，更新用户的个人资料 @Accept json @Produce json @Accept application/x-json-stream @Success 200 "{"code":200,"data":{},"message":"操作成功"}" @Param ModifyProfilesRequest body usershandlers.ModifyProfilesRequest true "更新个人信息" @Router /users/modifyprofile [post]

func (*UsersHandlers) ModifyPassword

func (u *UsersHandlers) ModifyPassword() gin.HandlerFunc

ModifyPassword defined as password modify API request handler @Summary 修改密码 @Tags 用户 @Description 使用短信验证码对密码进行修改 @Accept json @Produce json @Accept application/x-json-stream @Param ModifyPasswordRequest body usershandlers.ModifyPasswordRequest true "修改密码" @Success 200 "{"code":200,"data":{"modified": true},"message":"操作成功"}" @Router /users/modifyPassword [post]

func (*UsersHandlers) NormalReg

func (u *UsersHandlers) NormalReg() gin.HandlerFunc

NormalReg is user registry API request hanndler @Summary 普通注册账户 @Tags 用户 @Description 普通注册账户 @Accept json @Produce json @Accept application/x-json-stream @Param NormalRegRequest body usershandlers.NormalRegRequest true "注册账户" @Success 200 "{"code":200,"data":{"user": {}},"message":"操作成功"}" @Router /users/normalReg [post]

func (*UsersHandlers) Profile

func (u *UsersHandlers) Profile() gin.HandlerFunc

Profile api @Summary 获取任意用户的个人资料（非敏感信息） @Tags 用户 @Description 用于获取任意用户的个人资料，包含头像等基础信息，该接口仅输出基本账户信息，如头像，签名 @Accept json @Produce json @Accept application/x-json-stream @Success 200 "{"code":200,"data":{},"message":"操作成功"}" @Router /users/profile/:userID [get]

func (*UsersHandlers) Search

func (u *UsersHandlers) Search() gin.HandlerFunc

Search user api @Summary 粉丝列表 @Tags 用户 @Description 搜索用户 @Accept json @Produce json @Accept application/x-json-stream @Param Authorization header string true "Authentication header" @Param ListSearchUserResult body usershandlers.ListSearchUserResult true "搜索用户" @Success 200 "{"code":200,"data":{},"message":"操作成功"}" @Router /users/search [post]