Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
Functions ¶
This section is empty.
Types ¶
type TokensController ¶
type TokensController struct {
beego.Controller
}
Token相关接口
func (*TokensController) Post ¶
func (this *TokensController) Post()
@Title LoginWithPhone @Description 通过手机号和密码获取Token（登录） @Param phone query string true "用户手机号" @Param secret query string true "加密处理后的密码，全部小写" @Success 201 {object} models.User @Failure 403 参数错误：缺失或格式错误 @Failure 422 手机号未注册/密码错误 @Failure 500 系统错误 @router / [post]
type UsersController ¶
type UsersController struct {
beego.Controller
}
用户系统相关接口
func (*UsersController) Get ¶
func (this *UsersController) Get()
@Title GetUserByUid @Description [允许游客]通过uid获取用户信息; <br>请求自己的信息返回所有字段; <br>请求他人信息只有uid, nickname, avatar, gender字段; <br>其中gender 0表示未知, 1表示男, 2表示女 @Param uid path int64 true "目标用户uid" @Param token query string true "自己的token" @Success 200 {object} models.User @Failure 401 token无效 @Failure 403 参数错误：非法uid @Failure 404 目标用户不存在 @router /:uid [get]
func (*UsersController) Patch ¶
func (this *UsersController) Patch()
@Title UpdateUserInfo @Description 修改用户自己的信息, 修改哪些字段就传哪些字段, 成功后返回所有字段, <br/>注意: N位中英数限制, 指只能有汉字/英文字母/阿拉伯数字, 不能有标点符号, 特殊符号, 每个汉字/字母/数字长度都算1 @Param token query string true "Token" @Param phone query string false "更换绑定手机号" @Param code query string false "手机验证码, 换绑手机号时需要" @Param wx_openid query string false "微信授权的openid" @Param wx_token query string false "微信授权的token" @Param qq_openid query string false "QQ授权的openid" @Param qq_token query string false "QQ授权的token" @Param wb_token query string false "微博授权的token" @Param nickname query string false "昵称, 小于12位中英数" @Param gender query int false "性别, 1为男, 2为女" @Param avatar query string false "头像url, 通过上传头像接口上传成功后获得" @Success 201 {object} models.User @Failure 401 token无效 @Failure 403 参数错误：缺失或格式错误 @Failure 500 系统错误 @router / [patch]
func (*UsersController) Post ¶
func (this *UsersController) Post()
@Title CreateUserWithPhone @Description 通过手机号注册, 返回所有字段 @Param phone query string true "用户手机号" @Param code query string true "手机验证码" @Param secret query string true "加密处理后的密码" @Param Authorization header string true "Basic auth的授权码, 计算方式见wiki" @Success 201 {object} models.User @Failure 401 basic auth失败 @Failure 403 参数错误：缺失或格式错误 @Failure 422 手机号已注册 @Failure 500 系统错误 @router / [post]
type VerificationsController ¶
type VerificationsController struct {
beego.Controller
}
验证码相关接口
func (*VerificationsController) Post ¶
func (this *VerificationsController) Post()
@Title CreateVerification @Description 请求短信验证码 @Param phone query string true "手机号" @Param Authorization header string true "Basic auth的授权码, 计算方式见wiki" @Success 201 "" "" @Failure 401 basic auth失败 @Failure 403 参数错误：缺失或格式错误 @Failure 422 手机号已注册 @Failure 500 系统错误 @router / [post]
Source Files