server

Documentation

Index

• func BootstrapDatabase(config Config) *mysql.ConnectionData
• type Api
  • func NewApi(cfg *Config) Api
  • func (a *Api) Bootstrap() error
• type Config
  • func NewConfig() *Config
• type Environment
  • func (e Environment) IsBeta() bool
  • func (e Environment) IsLocal() bool
  • func (e Environment) IsProduction() bool
  • func (e Environment) IsTest() bool
• type Scope
• type Shutdown

Functions

func BootstrapDatabase

func BootstrapDatabase(config Config) *mysql.ConnectionData

Types

type Api

type Api struct {
	Cfg    *Config
	Router *mux.Router
}

func NewApi

func NewApi(cfg *Config) Api

func (*Api) Bootstrap

func (a *Api) Bootstrap() error

type Config

type Config struct {
	Environment      Environment
	LogLevel         string
	Port             string
	Network          string
	ReadTimeout      time.Duration
	WriteTimeout     time.Duration
	IdleTimeout      time.Duration
	DatabaseUsername string
	DatabasePassword string
	DatabaseHost     string
	DatabaseSchema   string
	DatabaseUrl      string
}

func NewConfig

func NewConfig() *Config

type Environment

type Environment string

const (
	PROD  Environment = "production"
	BETA  Environment = "beta"
	LOCAL Environment = "local"
	TEST  Environment = "test"
)

func (Environment) IsBeta

func (e Environment) IsBeta() bool

func (Environment) IsLocal

func (e Environment) IsLocal() bool

func (Environment) IsProduction

func (e Environment) IsProduction() bool

func (Environment) IsTest

func (e Environment) IsTest() bool

type Scope

type Scope interface {
	Bootstrap(cfg Config) error
}

type Shutdown

type Shutdown func() error