controllers

package
v0.0.0-...-79875cf Latest Latest
Warning

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

Go to latest
Published: Sep 29, 2024 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type UserController

type UserController interface {
	GetAll(ctx *gin.Context)
	GetById(ctx *gin.Context)
	Create(ctx *gin.Context)
	Update(ctx *gin.Context)
	Delete(ctx *gin.Context)
}

func NewUserController

func NewUserController(UserService services.UserService) UserController

type UserControllerImpl

type UserControllerImpl struct {
	// contains filtered or unexported fields
}

func (*UserControllerImpl) Create

func (uci *UserControllerImpl) Create(ctx *gin.Context)

@Summary Create User @Router /users [post] @Description Create User With The Given Input Data @Tags users @Accept json @Produce json @Param Input body models.User true "Create user object" @Success 201 {object} models.SuccessData[models.User] "Created" @Failure 400 {object} models.Error "Bad Request" @Failure 409 {object} models.Error "Error Conflict" @Failure 500 {object} models.Error "Internal Server Error"

func (*UserControllerImpl) Delete

func (uci *UserControllerImpl) Delete(ctx *gin.Context)

@Summary Delete User By ID @Router /users/{id} [delete] @Description Delete User By ID @Tags users @Accept json @Produce json @Param id path string true "User ID" @Success 200 {object} models.Success[models.User] "Deleted" @Failure 400 {object} models.Error "Bed Request" @Failure 404 {object} models.Error "Not Found" @Failure 500 {object} models.Error "Internal Server Error"

func (*UserControllerImpl) GetAll

func (uci *UserControllerImpl) GetAll(ctx *gin.Context)

@Summary Search All Users @Router /users [get] @Description Search All Users @Tags users @Accept json @Produce json @Success 200 {object} models.SuccessList[models.User] "OK" @Failure 500 {object} models.Error "Internal Server Error"

func (*UserControllerImpl) GetById

func (uci *UserControllerImpl) GetById(ctx *gin.Context)

@Summary Search User By ID @Router /users/{id} [get] @Description Get User By ID @Tags users @Accept json @Produce json @Param id path string true "User ID" @Success 200 {object} models.SuccessData[models.User] "OK" @Failure 400 {object} models.Error "Bad Request" @Failure 404 {object} models.Error "Not Found" @Failure 500 {object} models.Error "Internal Server Error"

func (*UserControllerImpl) Update

func (uci *UserControllerImpl) Update(ctx *gin.Context)

@Summary Update User By ID @Router /users [put] @Description Update Data User By ID With The Given Input Data @Tags users @Accept json @Produce json @Param Input body models.User true "Update user object" @Success 200 {object} models.SuccessData[models.User] "Updated" @Failure 400 {object} models.Error "Bad Request" @Failure 404 {object} models.Error "Not Found" @Failure 409 {object} models.Error "Error Conflict" @Failure 500 {object} models.Error "Internal Server Error"

Jump to

Keyboard shortcuts

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