handler

README

handler

This package contains handler that handle http request for each endpoints. Every handler should be simple and light, it's should only responsible for decoding request, calling business service, and encoding the response.

It's recommended to avoid implementing any business logic directly in handler, including writes to the database. Even if the logic seems simple at the beginning, implementing the logic directly in the handler might trigger tech-debt when additional requirement comes and other engineer just added the implementation directly in handler without moving it to a specific service.

Documentation

Index

• Variables
• type Healthz
  • func NewHealthz() Healthz
  • func (h *Healthz) Add(name string, ping Pinger)
  • func (h *Healthz) Mount(router iris.Party)
  • func (h Healthz) Show(c iris.Context)
• type Pinger
• type Score
  • func NewScore(repository rel.Repository) Score
  • func (s Score) Index(c iris.Context)
  • func (s Score) Mount(router iris.Party)
  • func (s Score) Points(c iris.Context)
• type Todos
  • func NewTodos(repository rel.Repository, todos todos.Service) Todos
  • func (t Todos) Clear(c iris.Context)
  • func (t Todos) Create(c iris.Context)
  • func (t Todos) Destroy(c iris.Context)
  • func (t Todos) Index(c iris.Context)
  • func (t Todos) Load(c iris.Context)
  • func (t Todos) Mount(router iris.Party)
  • func (t Todos) Show(c iris.Context)
  • func (t Todos) Update(c iris.Context)

Variables

var ErrBadRequest = errors.New("Bad Request")

ErrBadRequest error.

Types

type Healthz

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

Healthz handler.

func NewHealthz

func NewHealthz() Healthz

NewHealthz handler.

func (*Healthz) Add

func (h *Healthz) Add(name string, ping Pinger)

Add a pinger.

func (*Healthz) Mount

func (h *Healthz) Mount(router iris.Party)

Mount handlers to router group.

func (Healthz) Show

func (h Healthz) Show(c iris.Context)

Show handle GET /

type Pinger

type Pinger interface {
	Ping(ctx context.Context) error
}

Pinger interface.

type Score

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

Score for score endpoints.

func NewScore

func NewScore(repository rel.Repository) Score

NewScore handler.

func (Score) Index

func (s Score) Index(c iris.Context)

Index handle GET /

func (Score) Mount

func (s Score) Mount(router iris.Party)

Mount handlers to router group.

func (Score) Points

func (s Score) Points(c iris.Context)

Points handle Get /points

type Todos

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

Todos for todos endpoints.

func NewTodos

func NewTodos(repository rel.Repository, todos todos.Service) Todos

NewTodos handler.

func (Todos) Clear

func (t Todos) Clear(c iris.Context)

Clear handle DELETE /

func (Todos) Create

func (t Todos) Create(c iris.Context)

Create handle POST /

func (Todos) Destroy

func (t Todos) Destroy(c iris.Context)

Destroy handle DELETE /{ID}

func (Todos) Index

func (t Todos) Index(c iris.Context)

Index handle GET /.

func (Todos) Load

func (t Todos) Load(c iris.Context)

Load is middleware that loads todos to context.

func (Todos) Mount

func (t Todos) Mount(router iris.Party)

Mount handlers to router group.

func (Todos) Show

func (t Todos) Show(c iris.Context)

Show handle GET /{ID}

func (Todos) Update

func (t Todos) Update(c iris.Context)

Update handle PATCH /{ID}