controller

Documentation

Index

• type Context
• type Error
  • func NewError(err error) *Error
• type UserController
  • func NewUserController(sqlHandler db.SqlHandler) *UserController
  • func (controller *UserController) Create(c echo.Context) (err error)
  • func (controller *UserController) Delete(c echo.Context) (err error)
  • func (controller *UserController) Index(c echo.Context) (err error)
  • func (controller *UserController) Show(c echo.Context) (err error)
  • func (controller *UserController) Update(c echo.Context) (err error)

Types

type Context

type Context interface {
	Param(string) string
	Bind(interface{}) error
	Status(int)
	JSON(int, interface{})
}

type Error

type Error struct {
	Message string
}

func NewError

func NewError(err error) *Error

type UserController

type UserController struct {
	Interactor usecase.UserInteractor
}

func NewUserController

func NewUserController(sqlHandler db.SqlHandler) *UserController

func (*UserController) Create

func (controller *UserController) Create(c echo.Context) (err error)

Create godoc @Summary Create user @Description Create user by body @Tags users @Accept json @Produce json @Param parameter body models.UserAttributes true "User attributes" @Success 201 {object} models.User @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /users [post]

func (*UserController) Delete

func (controller *UserController) Delete(c echo.Context) (err error)

Delete godoc @Summary Delete user @Description Delete user by id @Tags users @Accept json @Produce json @Param id path string true "User ID" @Success 204 {object} nil @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /users/{id} [delete]

func (*UserController) Index

func (controller *UserController) Index(c echo.Context) (err error)

Index godoc @Summary List users @Description Get all users @Tags users @Accept json @Produce json @Success 200 {object} models.Users @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /users [get]

func (*UserController) Show

func (controller *UserController) Show(c echo.Context) (err error)

Show godoc @Summary Show an user @Description Get user by ID @Tags users @Accept json @Produce json @Param id path string true "User ID" @Success 200 {object} models.User @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /users/{id} [get]

func (*UserController) Update

func (controller *UserController) Update(c echo.Context) (err error)

Update godoc @Summary Update user @Description Update user by body @Tags users @Accept json @Produce json @Param id path string true "User ID" @Param parameter body models.UserAttributes true "User attributes" @Success 200 {object} models.User @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /users/{id} [put]