user

package
v2.11.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 24, 2025 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Login

func Login(c *gin.Context)

@tags user @accept json @produce json @param X-XSRF-TOKEN header string true "csrf token" @param request body user.UserLoginRequest true "login user" @success 200 {object} response.Response{data=user.TokenData} @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request), 400-002(request validation failed), 400-003(email is wrong), 400-004(password is wrong)" @failure 403 {object} response.ErrorResponse "code: 403-001(Forbidden)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/user/login [post]

func Me

func Me(c *gin.Context)

@tags user @accept json @produce json @param Authorization header string true "bearer token" @success 200 {object} response.Response{data=UserData} @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request)" @failure 401 {object} response.ErrorResponse "code: 401-001(Unauthorized)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/user/me [get]

func Register

func Register(c *gin.Context)

@tags user @accept json @produce json @param X-XSRF-TOKEN header string true "csrf token" @param request body user.UserRegisterRequest true "register user" @success 200 {object} response.Response{data=user.TokenData} @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request), 400-002(request validation failed)" @failure 403 {object} response.ErrorResponse "code: 403-001(Forbidden)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/user/register [post]

func Update

func Update(c *gin.Context)

@tags user @accept json @produce json @param X-XSRF-TOKEN header string true "csrf token" @param Authorization header string true "bearer token" @param request body user.UserUpdateRequest true "update user" @success 200 {object} response.Response{data=user.UserData} @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request), 400-002(request validation failed)" @failure 401 {object} response.ErrorResponse "code: 401-001(Unauthorized)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/user [put]

func UpdatePassword

func UpdatePassword(c *gin.Context)

@tags user @accept json @produce json @param X-XSRF-TOKEN header string true "csrf token" @param Authorization header string true "bearer token" @param request body user.UserUpdatePasswordRequest true "update user" @success 204 "no content" @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request), 400-002(request validation failed)" @failure 401 {object} response.ErrorResponse "code: 401-001(Unauthorized)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/user/password [put]

Types

type PermissionData

type PermissionData struct {
	Id        uint      `json:"id" mapstructure:"id" validate:"required"`
	Name      string    `json:"name" mapstructure:"name" validate:"required"`
	CreatedAt time.Time `json:"created_at" mapstructure:"created_at" validate:"required" format:"date-time"`
	UpdatedAt time.Time `json:"updated_at" mapstructure:"updated_at" validate:"required" format:"date-time"`
}

func (*PermissionData) Fill

func (data *PermissionData) Fill(m *model.Permission)

type RoleData

type RoleData struct {
	Id          uint             `json:"id" mapstructure:"id" validate:"required"`
	Name        string           `json:"name" mapstructure:"name" validate:"required"`
	CreatedAt   time.Time        `json:"created_at" mapstructure:"created_at" validate:"required" format:"date-time"`
	UpdatedAt   time.Time        `json:"updated_at" mapstructure:"updated_at" validate:"required" format:"date-time"`
	Permissions []PermissionData `json:"permissions" mapstructure:"permissions" validate:"required"`
}

func (*RoleData) Fill

func (data *RoleData) Fill(m *model.Role)

type TokenData

type TokenData struct {
	AccessToken string `json:"access_token" mapstructure:"access_token" validate:"required"`
}

func (*TokenData) Fill

func (data *TokenData) Fill(accessToken string)

type UserData

type UserData struct {
	Id        uint       `json:"id" mapstructure:"id" validate:"required"`
	Name      string     `json:"name" mapstructure:"name" validate:"required"`
	Email     string     `json:"email" mapstructure:"email" validate:"required"`
	CreatedAt time.Time  `json:"created_at" mapstructure:"created_at" validate:"required" format:"date-time"`
	UpdatedAt time.Time  `json:"updated_at" mapstructure:"updated_at" validate:"required" format:"date-time"`
	Roles     []RoleData `json:"roles" mapstructure:"roles" validate:"required"`
}

func (*UserData) Fill

func (data *UserData) Fill(m *model.User)

type UserLoginRequest

type UserLoginRequest struct {
	Email    string `json:"email" binding:"required,email"`
	Password string `json:"password" binding:"required"`
}

type UserRegisterRequest

type UserRegisterRequest struct {
	Name     string `json:"name" binding:"required"`
	Email    string `json:"email" binding:"required,email"`
	Password string `` /* 141-byte string literal not displayed */
}

type UserUpdatePasswordRequest

type UserUpdatePasswordRequest struct {
	CurrentPassword string `json:"current_password" binding:"required" structs:"-"`
	Password        string `` /* 160-byte string literal not displayed */
	ConfirmPassword string `json:"confirm_password" binding:"required,eqfield=Password" structs:"-"`
}

type UserUpdateRequest

type UserUpdateRequest struct {
	Name  string `json:"name" binding:"required" structs:"name"`
	Email string `json:"email" binding:"required" structs:"email"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL