httpserver

Documentation

Index

• func BaseRouter(r *chi.Mux, ns string)
• type ControllerRegistry
• type RouterConfig
• type Server
  • func NewServer(c *ServerConfig) (*Server, error)
  • func (s *Server) Serve() error
• type ServerConfig

Functions

func BaseRouter

func BaseRouter(r *chi.Mux, ns string)

BaseRouter only exists to easily verify a working app and should normally be removed

Types

type ControllerRegistry

type ControllerRegistry struct {
	ExampleController example.ExampleController
}

type RouterConfig

type RouterConfig struct {
	Namespace string `validate:"required"`
}

type Server

type Server struct {
	Logger *logger.CustomLogger
	Port   uint
	Server *http.Server
}

Server defines a server for handling HTTP API requests

func NewServer

func NewServer(c *ServerConfig) (*Server, error)

NewServer returns a new Server instance

func (*Server) Serve

func (s *Server) Serve() error

Serve starts the HTTP server on the configured address

type ServerConfig

type ServerConfig struct {
	Controllers  *ControllerRegistry  `validate:"required"`
	Host         string               `validate:"required"`
	Logger       *logger.CustomLogger `validate:"required"`
	Port         uint                 `validate:"required"`
	RouterConfig *RouterConfig        `validate:"required"`
}

ServerConfig defines the input to NewServer