api

Documentation

Index

• type EchoConfig
• type LoggerConfig
• type Server
  • func DefaultServerFromEnv() *Server
  • func NewServer(config ServerConfig) *Server
  • func (s *Server) InitManager(ctx context.Context) error
  • func (s *Server) Ready() bool
  • func (s *Server) Shutdown(ctx context.Context) error
  • func (s *Server) Start() error
• type ServerConfig
  • func DefaultServerConfigFromEnv() ServerConfig

Types

type EchoConfig

type EchoConfig struct {
	Debug                         bool
	ListenAddress                 string
	EnableCORSMiddleware          bool
	EnableLoggerMiddleware        bool
	EnableRecoverMiddleware       bool
	EnableRequestIDMiddleware     bool
	EnableTrailingSlashMiddleware bool
	EnableTimeoutMiddleware       bool
	RequestTimeout                time.Duration
}

type LoggerConfig

type LoggerConfig struct {
	Level              zerolog.Level
	RequestLevel       zerolog.Level
	LogRequestBody     bool
	LogRequestHeader   bool
	LogRequestQuery    bool
	LogResponseBody    bool
	LogResponseHeader  bool
	PrettyPrintConsole bool
}

type Server

type Server struct {
	Config  ServerConfig
	Echo    *echo.Echo
	Manager *manager.Manager
}

func DefaultServerFromEnv

func DefaultServerFromEnv() *Server

func NewServer

func NewServer(config ServerConfig) *Server

func (*Server) InitManager

func (s *Server) InitManager(ctx context.Context) error

func (*Server) Ready

func (s *Server) Ready() bool

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

func (*Server) Start

func (s *Server) Start() error

type ServerConfig

type ServerConfig struct {
	Address        string
	Port           int
	DebugEndpoints bool
	Logger         LoggerConfig
	Echo           EchoConfig
}

func DefaultServerConfigFromEnv

func DefaultServerConfigFromEnv() ServerConfig