system

Documentation

Overview

Package system provides system builder which response for properties dependency injection.

The auto configuration composes properties object

Example

This example shows how to use the system build

package main

import ()

func main() {

}

Index

• func ReadYamlFromFile(file string) (prop map[string]interface{}, err error)
• type App
• type Builder
  • func NewBuilder(configuration interface{}, path, name, fileType string, ...) Builder
• type Configuration
• type Env
• type ErrInvalidController
  • func (e *ErrInvalidController) Error() string
• type ErrNotFound
  • func (e *ErrNotFound) Error() string
• type Logging
• type Profiles
• type Server

Examples

• Package

Functions

func ReadYamlFromFile

func ReadYamlFromFile(file string) (prop map[string]interface{}, err error)

ReadYamlFromFile read yaml from file directly

Types

type App

type App struct {
	// project name
	Project string `json:"project" default:"hidevopsio"`
	// app name
	Name string `json:"name" default:"hiboot-app"`
	// app description
	Description string `json:"description" default:"${app.name} is a Hiboot Application"`
	// profiles
	Profiles Profiles `json:"profiles"`
	// banner
	Banner banner
}

App is the properties of the application, it hold the base info of the application

type Builder

type Builder interface {
	Init() error
	Build(profiles ...string) (interface{}, error)
	BuildWithProfile(profile string) (interface{}, error)
	Save(p interface{}) error
	Replace(source string) (retVal interface{})
	GetProperty(name string) (retVal interface{})
	SetProperty(name string, val interface{}) Builder
	SetConfiguration(in interface{})
}

Builder is the config file (yaml, json) builder

func NewBuilder

func NewBuilder(configuration interface{}, path, name, fileType string, customProperties map[string]interface{}) Builder

NewBuilder is the constructor of system.Builder

type Configuration

type Configuration struct {
	App     App     `mapstructure:"app"`
	Server  Server  `mapstructure:"server"`
	Logging Logging `mapstructure:"logging"`
}

Configuration is the system configuration

type Env

type Env struct {
	// env name
	Name string
	// env value
	Value string
}

Env is the name value pair of environment variable

type ErrInvalidController

type ErrInvalidController struct {
	Name string
}

ErrInvalidController invalid controller

func (*ErrInvalidController) Error

func (e *ErrInvalidController) Error() string

type ErrNotFound

type ErrNotFound struct {
	Name string
}

ErrNotFound resource not found error

func (*ErrNotFound) Error

func (e *ErrNotFound) Error() string

type Logging

type Logging struct {
	Level string `json:"level" default:"info"`
}

Logging is the properties of logging

type Profiles

type Profiles struct {
	// set to true or false to filter in included profiles or not
	Filter bool `json:"filter" default:"false"`
	// included profiles
	Include []string `json:"include"`
	// active profile
	Active string `json:"active" default:"${APP_PROFILES_ACTIVE:default}"`
}

Profiles is app profiles .include auto configuration starter should be included inside this slide .active active profile

type Server

type Server struct {
	Port string `json:"port" default:"8080"`
}

Server is the properties of http server