rest

Documentation

Index

• type Config
• type GetConfig
• type GetHandler
  • func NewGetHandler(cfg GetConfig, model GetModel) *GetHandler
  • func (h *GetHandler) ServeHTTP(response http.ResponseWriter, request *http.Request)
• type GetModel
• type ListHandler
  • func NewListHandler(model ListModel) *ListHandler
  • func (h *ListHandler) ServeHTTP(response http.ResponseWriter, request *http.Request)
• type ListModel
• type RegisterHandler
  • func NewRegisterHandler(model RegisterModel) *RegisterHandler
  • func (h *RegisterHandler) ServeHTTP(response http.ResponseWriter, request *http.Request)
• type RegisterModel
• type Server
  • func New(cfg Config, getModel GetModel, listModel ListModel, ...) *Server
  • func (s *Server) Listen(stop <-chan struct{})

Types

type Config

type Config interface {
	Logger() logging.Logger
	BindAddress() string
}

Config is the config for the REST package

type GetConfig

type GetConfig interface {
	Logger() logging.Logger
}

GetConfig is the config for the Get Handler

type GetHandler

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

GetHandler is the HTTP handler for the "Get Person" endpoint In this simplified example we are assuming all possible errors are user errors and returning "bad request" HTTP 400 or "not found" HTTP 404 There are some programmer errors possible but hopefully these will be caught in testing.

func NewGetHandler

func NewGetHandler(cfg GetConfig, model GetModel) *GetHandler

NewGetHandler is the constructor for GetHandler

func (*GetHandler) ServeHTTP

func (h *GetHandler) ServeHTTP(response http.ResponseWriter, request *http.Request)

ServeHTTP implements http.Handler

type GetModel

type GetModel interface {
	Do(ID int) (*data.Person, error)
}

GetModel will load a registration

type ListHandler

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

ListHandler is the HTTP handler for the "List Do people" endpoint In this simplified example we are assuming all possible errors are system errors (HTTP 500)

func NewListHandler

func NewListHandler(model ListModel) *ListHandler

NewLister is the constructor for ListHandler

func (*ListHandler) ServeHTTP

func (h *ListHandler) ServeHTTP(response http.ResponseWriter, request *http.Request)

ServeHTTP implements http.Handler

type ListModel

type ListModel interface {
	Do() ([]*data.Person, error)
}

ListModel will load all registrations

type RegisterHandler

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

RegisterHandler is the HTTP handler for the "Register" endpoint In this simplified example we are assuming all possible errors are user errors and returning "bad request" HTTP 400. There are some programmer errors possible but hopefully these will be caught in testing.

func NewRegisterHandler

func NewRegisterHandler(model RegisterModel) *RegisterHandler

NewRegisterHandler is the constructor for RegisterHandler

func (*RegisterHandler) ServeHTTP

func (h *RegisterHandler) ServeHTTP(response http.ResponseWriter, request *http.Request)

ServeHTTP implements http.Handler

type RegisterModel

type RegisterModel interface {
	Do(ctx context.Context, in *data.Person) (int, error)
}

RegisterModel will validate and save a registration

type Server

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

Server is the HTTP REST server

func New

func New(cfg Config,
	getModel GetModel,
	listModel ListModel,
	registerModel RegisterModel) *Server

New will create and initialize the server

func (*Server) Listen

func (s *Server) Listen(stop <-chan struct{})

Listen will start a HTTP rest for this service