rest

Documentation

Index

• Variables
• func DefaultRouter(serviceName string, allowedOrigins []string, logger *zap.Logger) *chi.Mux
• func NewLogger(env string) (*zap.Logger, error)
• type Server
  • func NewServer(serviceName string, serverPort, metricsPort int, router *chi.Mux, ...) *Server
  • func (s *Server) Run()

Variables

var ErrInvalidEnvironment = errors.New("unknown environment")

ErrInvalidEnvironment is returned when value of the passed environment is not valid.

Functions

func DefaultRouter

func DefaultRouter(serviceName string, allowedOrigins []string, logger *zap.Logger) *chi.Mux

DefaultRouter creates chi mux with default middlewares. Supply nil for allowedOrigins to turn off CORS middleware. Example string for allowedOrigins: "https://example.com".

func NewLogger

func NewLogger(env string) (*zap.Logger, error)

NewLogger creates new zap logger.

Types

type Server

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

Server runs REST and metrics servers.

func NewServer

func NewServer(serviceName string, serverPort, metricsPort int, router *chi.Mux, logger *zap.Logger) *Server

NewServer creates new server.

func (*Server) Run

func (s *Server) Run()

Run starts REST and metrics servers.