package
0.0.0-20220126111042-bcd2c7cf3f6d
Repository: https://github.com/codehanhan/ferry-backend.git
Documentation: pkg.go.dev
# Functions
AdminUpadate godoc @Summary 管理员更新用户信息 @Description 管理员更新个人信息 @Tags user @ID user-adminupdateuser @Param username query string true "Username" @Param nickname query string false "昵称" @Param password query string false "密码" @Param email query string false "邮箱" @Success 200 {object} formUser.UpdateUserResponse @Failure 500 {object} app.ErrResponse @Failure 400 {object} app.ErrResponse @Produce json @Router /user/adminupdateuser [patch] @Security BearerAuth.
Captcha godoc @Summary 获取验证码 @Description 获取验证码 @Tags captcha @ID get-captcha @Success 200 {object} formUser.CaptchaResponse @Failure 500 {object} app.ErrResponse @Produce json @Router /captcha [get].
Changepassword godoc @Summary 用户更新密码 @Description 用户更新密码 @Tags user @ID user-changepassword @Param oldpassword query string true "旧密码" @Param newpassword query string true "新密码" @Success 200 {object} formUser.UpdateUserResponse @Failure 500 {object} app.ErrResponse @Failure 400 {object} app.ErrResponse @Produce json @Router /user/changepassword [patch] @Security BearerAuth.
Register godoc @Summary 创建用户信息 @Description 管理员创建用户个人信息 @Tags user @ID user-createsysuser @Param username query string true "用户名" @Param password query string true "密码" @Param role query string true "角色" @Param email query string true "邮箱" @Success 200 {object} formUser.CreateUserResponse @Failure 500 {object} app.ErrResponse @Failure 400 {object} app.ErrResponse @Produce json @Router /user [post] @Security BearerAuth.
Delete godoc @Summary 删除用户信息 @Description 管理员删除用户个人信息 @Tags user @ID user-deletesysuser @Param id query string true "用户ID" @Success 200 {object} formUser.DeleteUserResponse @Failure 500 {object} app.ErrResponse @Failure 400 {object} app.ErrResponse @Produce json @Router /user [delete] @Security BearerAuth.
Login godoc @Summary 用户名密码登录 @Description 获取token @Tags user @ID user-login @Param username query string true "用户名" @Param password query string true "密码" @Param id query string true "验证码id" @Param code query string true "验证码内容" @Success 200 {object} formUser.LoginResponse @Failure 500 {object} app.ErrResponse @Failure 400 {object} app.ErrResponse @Produce json @Router /login [post].
LoginTest godoc @Summary 用户名密码登录(测试用) @Description 获取token @Tags user @ID user-logintest @Param username query string true "用户名" @Param password query string true "密码" @Success 200 {object} formUser.LoginResponse @Failure 500 {object} app.ErrResponse @Failure 400 {object} app.ErrResponse @Produce json @Router /logintest [get].
Profile godoc @Summary 查看个人信息 @Description 用户查看个人信息 @Tags user @ID user-me @Success 200 {object} formUser.ProfileResponse @Failure 500 {object} app.ErrResponse @Produce json @Router /user/me [get] @Security BearerAuth.
Upadate godoc @Summary 更新用户信息 @Description 用户更新个人信息 @Tags user @ID user-updateuser @Param nickname query string false "昵称" @Param email query string false "邮箱" @Success 200 {object} formUser.UpdateUserResponse @Failure 500 {object} app.ErrResponse @Failure 400 {object} app.ErrResponse @Produce json @Router /user/updateuser [patch] @Security BearerAuth.
@Summary 上传头像 @Description 上传头像图片,只支持png, jpeg, jpg @Tags user @ID user-avatar @Param avatar body formUser.UploadAvatarRequest true "用户头像" @Success 200 {object} formUser.UploadAvatarResponse @Failure 500 {object} app.ErrResponse @Failure 400 {object} app.ErrResponse @Accept application/json @Produce json @Router /user/upload [post] @Security BearerAuth.
Captcha godoc @Summary 验证验证码 @Description 验证验证码 @Tags captcha @ID verify-captcha @Param id query string true "验证码id" @Param code query string true "验证码内容" @Success 200 {object} formUser.VerifyCaptchaResponse @Failure 400 {object} app.ErrResponse @Produce json @Router /captcha [post].