config

Documentation

Index

• Variables
• type Config
  • func GetConfig(path string) (*Config, error)
• type DBConfig

Variables

var ErrFileNotFound = errors.New("file config.yml was not found")

ErrFileNotFound is returned if the file was not found.

var ErrInvalidYamlFile = errors.New("file config.yaml has invalid content")

ErrInvalidYamlFile is return when the file does not satisfy the yaml file type.

Types

type Config

type Config struct {
	Port     int       `yaml:"Port"`
	DBConfig *DBConfig `yaml:"DB"`
}

Config defines a configuration for the web API.

func GetConfig

func GetConfig(path string) (*Config, error)

GetConfig tries to load and handle the configuration file.

type DBConfig

type DBConfig struct {
	Host     string `yaml:"Host"`
	Port     int    `yaml:"Port"`
	User     string `yaml:"User"`
	Password string `yaml:"Password"`
	DBname   string `yaml:"Database_Name"`
}

DBConfig holds database connection's credentials.