user

Documentation

Overview

*

• @author:cb <fastopencn@gmail.com>
• @date:2022/5/26 *

*

• @author:cb <fastopencn@gmail.com>
• @date:2022/5/26 *

*

• @author:cb <fastopencn@gmail.com>
• @date:2022/5/26 *

*

• @author:cb <fastopencn@gmail.com>
• @date:2022/5/26 *

*

• @author:cb <fastopencn@gmail.com>
• @date:2022/5/26 *

*

• @author:cb <fastopencn@gmail.com>
• @date:2022/5/26 *

*

• @author:cb <fastopencn@gmail.com>
• @date:2022/5/26 *

Index

• func RegisterRoutes(r *gin.Engine) error
• type UserApi
  • func (api *UserApi) Login(c *gin.Context)
  • func (api *UserApi) Logout(c *gin.Context)
  • func (api *UserApi) Register(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

RegisterRoutes 注册路由

Types

type UserApi

type UserApi struct{}

func (*UserApi) Login

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

Login 登录 @Summary 用户登录 @Description 用户登录接口 @Accept json @Produce json @Tags user @Param loginParam body loginParam true "login with param" @Success 200 string Token "token" @Router /user/login [post]

func (*UserApi) Logout

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

Logout 用户退出 @Summary 用户登出 @Description 注销用户登录信息 @Accept json @Produce json @Tags user @Success 200 {string} Message "用户退出成功" @Router /user/logout [get]

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 string Message "注册成功" @Router /user/register [post]

func (*UserApi) Verify

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

Verify 验证注册信息 @Summary 验证注册信息 @Description 使用token验证用户注册信息 @Accept json @Produce json @Tags user @Param token query string true "注册token" @Success 200 {string} Message "注册成功，请进入登录页面" @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