Documentation
¶
Index ¶
- type UserHandler
- type UserHandlerImpl
- func (h *UserHandlerImpl) Login(ctx echo.Context) error
- func (h *UserHandlerImpl) Profile(ctx echo.Context) error
- func (h *UserHandlerImpl) RefreshToken(ctx echo.Context) error
- func (h *UserHandlerImpl) Register(ctx echo.Context) error
- func (h *UserHandlerImpl) RequestReset(ctx echo.Context) error
- func (h *UserHandlerImpl) ResetPassword(ctx echo.Context) error
- func (h *UserHandlerImpl) Update(ctx echo.Context) error
- func (h *UserHandlerImpl) VerifyEmail(ctx echo.Context) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type UserHandler ¶
type UserHandler interface {
Login(ctx echo.Context) error
Register(ctx echo.Context) error
Profile(ctx echo.Context) error
Update(ctx echo.Context) error
RefreshToken(ctx echo.Context) error
RequestReset(ctx echo.Context) error
ResetPassword(ctx echo.Context) error
VerifyEmail(ctx echo.Context) error
}
type UserHandlerImpl ¶
type UserHandlerImpl struct {
Log *logrus.Logger
User user.UserService
}
func NewUserHandler ¶
func NewUserHandler(log *logrus.Logger, userService user.UserService) *UserHandlerImpl
func (*UserHandlerImpl) Login ¶
func (h *UserHandlerImpl) Login(ctx echo.Context) error
Login function is a handler to login user @Summary Login user @Description Login user @Tags user @Accept json @Produce json @Param user body model.LoginRequest true "User data" @Success 200 {object} model.Response[model.TokenResponse] @Failure 400 {object} model.Error @Failure 401 {object} model.Error @Failure 500 {object} model.Error @Router /users/login [post]
func (*UserHandlerImpl) Profile ¶
func (h *UserHandlerImpl) Profile(ctx echo.Context) error
Profile function is a handler to get user profile @Summary Get user profile @Description Get user profile @Tags user @Accept json @Produce json @Success 200 {object} model.Response[model.UserResponse] @Failure 400 {object} model.Error @Failure 404 {object} model.Error @Failure 500 {object} model.Error @security ApiKeyAuth @Router /users [get]
func (*UserHandlerImpl) RefreshToken ¶
func (h *UserHandlerImpl) RefreshToken(ctx echo.Context) error
RefreshToken function is a handler to refresh token @Summary Refresh token @Description Refresh token @Tags user @Accept json @Produce json @Param user body model.RefreshTokenRequest true "User data" @Success 200 {object} model.Response[model.TokenResponse] @Failure 400 {object} model.Error @Failure 401 {object} model.Error @Failure 500 {object} model.Error @Router /users/refresh [post]
func (*UserHandlerImpl) Register ¶
func (h *UserHandlerImpl) Register(ctx echo.Context) error
Register function is a handler to register a new user @Summary Register a new user @Description Register a new user @Tags user @Accept json @Produce json @Param user body model.RegisterRequest true "User data" @Success 201 {object} model.Response[model.UserResponse] @Failure 400 {object} model.Error @Failure 500 {object} model.Error @Router /users [post]
func (*UserHandlerImpl) RequestReset ¶
func (h *UserHandlerImpl) RequestReset(ctx echo.Context) error
RequestReset function is a handler to request reset password via email @Summary Request reset password via email @Description Request reset password via email @Tags user @Accept json @Produce json @Param user body model.ReqResetPasswordRequest true "User data" @Success 200 {object} model.Response[model.VerifyResponse] @Failure 400 {object} model.Error @Failure 404 {object} model.Error @Failure 500 {object} model.Error @Router /users/request-reset [post]
func (*UserHandlerImpl) ResetPassword ¶
func (h *UserHandlerImpl) ResetPassword(ctx echo.Context) error
ResetPassword function is a handler to reset password @Summary Reset password @Description Reset password @Tags user @Accept json @Produce json @Param user body model.ResetPasswordRequest true "User data" @Success 200 {object} model.Response[model.VerifyResponse] @Failure 400 {object} model.Error @Failure 404 {object} model.Error @Failure 500 {object} model.Error @Router /users/reset-password [post]
func (*UserHandlerImpl) Update ¶
func (h *UserHandlerImpl) Update(ctx echo.Context) error
Update function is a handler to update user profile @Summary Update user profile @Description Update user profile @Tags user @Accept json @Produce json @Param user body model.UpdateUserRequest true "User data" @Success 200 {object} model.Response[model.UserResponse] @Failure 400 {object} model.Error @Failure 404 {object} model.Error @Failure 500 {object} model.Error @security ApiKeyAuth @Router /users [put]
func (*UserHandlerImpl) VerifyEmail ¶
func (h *UserHandlerImpl) VerifyEmail(ctx echo.Context) error
VerifyEmail function is a handler to verify email @Summary Verify email @Description Verify email @Tags user @Accept json @Produce json @Param token path string true "Token" @Success 200 {object} model.Response[model.VerifyResponse] @Failure 400 {object} model.Error @Failure 404 {object} model.Error @Failure 500 {object} model.Error @Router /users/verify-email/{token} [get]
Source Files