user

Documentation

Index

• type Api
  • func NewUserApi(basic *v1.BasicApi, service Service) *Api
  • func (r *Api) Active(ctx *gin.Context)
  • func (r *Api) ActiveFailure(ctx *gin.Context)
  • func (r *Api) ActiveSuccess(ctx *gin.Context)
  • func (r *Api) GetUserList(ctx *gin.Context)
  • func (r *Api) Login(ctx *gin.Context)
  • func (r *Api) Logout(ctx *gin.Context)
  • func (r *Api) Profile(ctx *gin.Context)
  • func (r *Api) SignUp(ctx *gin.Context)
• type Service

Types

type Api

type Api struct {
	*v1.BasicApi
	// contains filtered or unexported fields
}

func NewUserApi

func NewUserApi(basic *v1.BasicApi, service Service) *Api

func (*Api) Active

func (r *Api) Active(ctx *gin.Context)

func (*Api) ActiveFailure

func (r *Api) ActiveFailure(ctx *gin.Context)

func (*Api) ActiveSuccess

func (r *Api) ActiveSuccess(ctx *gin.Context)

func (*Api) GetUserList

func (r *Api) GetUserList(ctx *gin.Context)

GetUserList

@Summary		获取用户列表
@Description	分页获取用户列表，支持关键词搜索
@Tags			用户管理
@Accept			json
@Produce		json
@Security		BearerAuth
@Param			keyword	query		string																	false	"搜索关键词"
@Param			limit	query		int																		false	"每页数量"	default(10)
@Param			offset	query		int																		false	"偏移量"	default(0)
@Success		10000	{object}	response.BasicResponse[response.DataList[response.UserListRowResponse]]	"获取成功，code=10000"
@Failure		10002	{object}	response.BasicResponse[any]												"参数验证失败，code=10002"
@Failure		10001	{object}	response.BasicResponse[any]												"服务器内部错误，code=10001"
@Router			/user/list [get]

func (*Api) Login

func (r *Api) Login(ctx *gin.Context)

Login

@Summary		用户登录
@Description	用户通过邮箱和密码进行登录
@Tags			用户管理
@Accept			json
@Produce		json
@Param			request	body		request.LoginRequest							true	"登录请求参数"
@Success		10000	{object}	response.BasicResponse[response.LoginResponse]	"登录成功，code=10000"
@Failure		10002	{object}	response.BasicResponse[any]						"参数验证失败，code=10002"
@Failure		20001	{object}	response.BasicResponse[any]						"登录失败，code=20001"
@Router			/public/user/login [post]

func (*Api) Logout

func (r *Api) Logout(ctx *gin.Context)

Logout

@Summary		退出登录
@Description	用户登出(退出登录)
@Tags			用户管理
@Accept			json
@Produce		json
@Success		10000	{object}	response.BasicResponse[response.LoginResponse]	"登出成功，code=10000"
@Failure		20001	{object}	response.BasicResponse[any]						"登出失败，code=20001"
@Router			/user/logout [post]

func (*Api) Profile

func (r *Api) Profile(ctx *gin.Context)

Profile

@Summary		获取用户资料
@Description	获取当前登录用户的详细资料信息
@Tags			用户管理
@Accept			json
@Produce		json
@Security		BearerAuth
@Success		10000	{object}	response.BasicResponse[response.ProfileResponse]	"获取成功，code=10000"
@Failure		20005	{object}	response.BasicResponse[any]							"用户不存在，code=20005"
@Failure		10001	{object}	response.BasicResponse[any]							"服务器内部错误，code=10001"
@Router			/user/profile [get]

func (*Api) SignUp

func (r *Api) SignUp(ctx *gin.Context)

SignUp

@Summary		用户注册
@Description	用户通过邮箱和密码进行注册
@Tags			用户管理
@Accept			json
@Produce		json
@Param			request	body		request.SignUpRequest		true	"注册请求参数"
@Success		10000	{object}	response.BasicResponse[any]	"注册成功，code=10000"
@Failure		10002	{object}	response.BasicResponse[any]	"参数验证失败，code=10002"
@Failure		20004	{object}	response.BasicResponse[any]	"邮箱格式错误，code=20004"
@Failure		20003	{object}	response.BasicResponse[any]	"密码格式错误，code=20003"
@Failure		10001	{object}	response.BasicResponse[any]	"业务逻辑失败，code=10001"
@Router			/public/user/signup [post]

type Service

type Service interface {
	SignUp(ctx context.Context, id string, code string, user *models.User) error
	Login(ctx context.Context, email string, password string) (*response.LoginResponse, error)
	Logout(ctx context.Context, email string) error
	Profile(ctx context.Context, uid uint) (*response.ProfileResponse, error)
	GetUserList(ctx context.Context, keyword string, limit, offset int) ([]*response.UserListRowResponse, int64, error)
	ActiveAccount(ctx context.Context, uid uint, activeCode string) error
}