server

Documentation

Index

• type APIDefinition
  • func APIFunc(start func(router.Router) error, stop func()) APIDefinition
• type Config
• type HealthChecker
• type Server
  • func New(log logrus.FieldLogger, projectName string, config Config, api APIDefinition) (*Server, error)
  • func (s *Server) ListenAndServe() error
  • func (s *Server) Shutdown(to time.Duration) error
  • func (s *Server) TestServer() *httptest.Server

Types

type APIDefinition

type APIDefinition interface {
	Start(r router.Router) error
	Stop()
}

APIDefinition is used to control lifecycle of the API

func APIFunc

func APIFunc(start func(router.Router) error, stop func()) APIDefinition

type Config

type Config struct {
	HealthPath string `split_words:"true"`
	Port       int
	TLS        nconf.TLSConfig
}

type HealthChecker

type HealthChecker interface {
	Healthy(w http.ResponseWriter, r *http.Request) *router.HTTPError
}

HealthChecker is used to run a custom health check Implement it on your API if you want it to be checked when the healthcheck is called

type Server

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

Server handles the setup and shutdown of the http server for an API

func New

func New(log logrus.FieldLogger, projectName string, config Config, api APIDefinition) (*Server, error)

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

func (*Server) Shutdown

func (s *Server) Shutdown(to time.Duration) error

func (*Server) TestServer

func (s *Server) TestServer() *httptest.Server