package
1.9.0
Repository: https://github.com/go-eagle/eagle.git
Documentation: pkg.go.dev

# Functions

Follow 关注 @Summary 通过用户id关注用户 @Description Get an user by user id @Tags 用户 @Accept json @Produce json @Param user_id body string true "用户id" @Success 200 {object} model.UserInfo "用户信息" @Router /users/follow [post].
FollowerList 粉丝列表 @Summary 通过用户id关注用户 @Description Get an user by user id @Tags 用户 @Accept json @Produce json @Param user_id body string true "用户id" @Success 200 {object} model.UserInfo "用户信息" @Router /users/{id}/followers [get].
FollowList 关注列表 @Summary 正在关注的用户列表 @Description Get an user by user id @Tags 用户 @Accept json @Produce json @Param user_id body string true "用户id" @Success 200 {object} model.UserInfo "用户信息" @Router /users/{id}/following [get].
Get 获取用户信息 @Summary 通过用户id获取用户信息 @Description Get an user by user id @Tags 用户 @Accept json @Produce json @Param id path string true "用户id" @Success 200 {object} model.UserInfo "用户信息" @Router /users/:id [get].
Login 邮箱登录 @Summary 用户登录接口 @Description 仅限邮箱登录 @Tags 用户 @Produce json @Param req body LoginCredentials true "请求参数" @Success 200 {object} model.UserInfo "用户信息" @Router /login [post].
PhoneLogin 手机登录接口 @Summary 用户登录接口 @Description 仅限手机登录 @Tags 用户 @Produce json @Param req body PhoneLoginCredentials true "phone" @Success 200 {object} model.UserInfo "用户信息" @Router /users/login [post].
Register 注册 @Summary 注册 @Description 用户注册 @Tags 用户 @Produce json @Param req body RegisterRequest true "请求参数" @Success 200 {object} model.UserInfo "用户信息" @Router /Register [post].
Unfollow 取消关注 @Summary 通过用户id取消关注用户 @Description Get an user by user id @Tags 用户 @Accept json @Produce json @Param user_id body string true "用户id" @Success 200 {object} model.UserInfo "用户信息" @Router /users/unfollow [post].
Update 更新用户信息 @Summary Update a user info by the user identifier @Description Update a user by ID @Tags 用户 @Accept json @Produce json @Param id path uint64 true "The user's database id index num" @Param user body model.UserBaseModel true "The user info" @Success 200 {object} app.Response "{"code":0,"message":"OK","data":null}" @Router /users/{id} [put].
VCode 获取验证码 @Summary 根据手机号获取校验码 @Description Get an user by username @Tags 用户 @Accept json @Produce json @Param area_code query string true "区域码,比如86" @Param phone query string true "手机号" @Success 200 {object} app.Response @Router /vcode [get].

# Structs

CreateRequest 创建用户请求.
CreateResponse 创建用户响应.
FollowRequest 关注请求.
ListResponse 通用列表resp.
LoginCredentials 默认登录方式-邮箱.
PhoneLoginCredentials 手机登录.
RegisterRequest 注册.
SwaggerListResponse 文档.
UpdateRequest 更新请求.