rest

Documentation

Index

• func NewLoggingMiddleware(logger abstraction.Logger) func(http.Handler) http.Handler
• type Handler
  • func NewHandler(logger abstraction.Logger, handlerName string) *Handler
  • func (h Handler) DecodeFromJSON(r io.Reader, value interface{}) error
  • func (h Handler) RespondWithError(w http.ResponseWriter, code int, message string)
  • func (h Handler) RespondWithJSON(w http.ResponseWriter, code int, payload interface{})
• type Settings
  • func DefaultSettings() *Settings

Functions

func NewLoggingMiddleware

func NewLoggingMiddleware(logger abstraction.Logger) func(http.Handler) http.Handler

NewLoggingMiddleware returns a middleware for logging requests

Types

type Handler

type Handler struct {
	*base.Component
}

Handler represents a basic REST handler

func NewHandler

func NewHandler(logger abstraction.Logger, handlerName string) *Handler

NewHandler returns a new basic REST handler instance

func (Handler) DecodeFromJSON

func (h Handler) DecodeFromJSON(r io.Reader, value interface{}) error

DecodeFromJSON obtains a value from the body of the request

func (Handler) RespondWithError

func (h Handler) RespondWithError(w http.ResponseWriter, code int, message string)

RespondWithError sends an error response in JSON Format

func (Handler) RespondWithJSON

func (h Handler) RespondWithJSON(w http.ResponseWriter, code int, payload interface{})

RespondWithJSON sends a response in RespondWithJSON Format

type Settings

type Settings struct {
	Address         string
	ReadTimeout     time.Duration
	WriteTimeout    time.Duration
	GracefulTimeout time.Duration
}

Settings contains the configuration values for the AppServer

func DefaultSettings

func DefaultSettings() *Settings

DefaultSettings provides the default settings for a server