user

Documentation

Index

• func RegisterRoutes(r *gin.Engine) error
• type UserApi
  • func (api *UserApi) Login(c *gin.Context)
  • func (api *UserApi) Register(c *gin.Context)
  • func (api *UserApi) RegisterMockUser(c *gin.Context)
  • func (api *UserApi) UserInfo(c *gin.Context)
  • func (api *UserApi) Verify(c *gin.Context)
• type UserDTO
  • func ConvertUserToDTO(user *user.User) *UserDTO

Functions

func RegisterRoutes

func RegisterRoutes(r *gin.Engine) error

Types

type UserApi

type UserApi struct{}

func (*UserApi) Login

func (api *UserApi) Login(c *gin.Context)

Login 代表登录 @Summary 用户登录 @Description 用户登录接口, 使用 data 字段返回用户token @Accept json @Produce json @Tags user @Param loginParam body loginParam true "login with param" @Success 200 {object} httputil.Response{data=string} @Failure 500 {object} httputil.HTTPError @Router /user/login [post]

func (*UserApi) Register

func (api *UserApi) Register(c *gin.Context)

Register 注册 @Summary 用户注册 @Description 用户注册接口 @Accept json @Produce json @Tags user @Param registerParam body registerParam true "注册参数" @Success 200 {object} httputil.Response @Failure 500 {object} httputil.HTTPError @Router /user/register [post]

func (*UserApi) RegisterMockUser

func (api *UserApi) RegisterMockUser(c *gin.Context)

Register 添加管理员用户 @Summary 添加管理员用户 @Description 添加管理员用户 用户名：admin 密码：admin123 邮箱：admin@123.com @Accept json @Produce json @Tags user @Success 200 {object} httputil.Response @Failure 500 {object} httputil.HTTPError @Router /user/mock-test-user [get]

func (*UserApi) UserInfo

func (api *UserApi) UserInfo(c *gin.Context)

UserInfo 获取登录用户信息 @Summary 登录用户信息 @Description 获取登录用户信息接口 @Accept json @Produce json @Tags user @Success 200 {object} httputil.Response{data=UserDTO} @Failure 500 {object} httputil.HTTPError @Router /user/userinfo [get]

func (*UserApi) Verify

func (api *UserApi) Verify(c *gin.Context)

Verify 代表验证注册信息 @Summary 验证注册信息 @Description 使用token验证用户注册信息 @Accept json @Produce json @Tags user @Param captcha query string true "注册的验证码" @Success 200 {object} httputil.Response @Failure 500 {object} httputil.HTTPError @Router /user/register-verify [get]

type UserDTO

type UserDTO struct {
	ID        int64     `json:"id,omitempty"`
	UserName  string    `json:"user_name,omitempty"`
	CreatedAt time.Time `json:"created_at"`
}

UserDTO 表示输出到外部的用户信息

func ConvertUserToDTO

func ConvertUserToDTO(user *user.User) *UserDTO

ConvertUserToDTO 将user转换为UserDTO