config

Documentation

Overview

Package config uses Viper to load all configuration from the yml config file.

Index

• Constants
• type AuthConfiguration
• type Configuration
  • func LoadAppConfig(filename string) (*Configuration, error)
• type ConsulConfiguration
• type DatabaseConfiguration
• type LogsConfiguration
• type SystemConfiguration

Constants

const (
	// APIUser represents the group of user management API
	APIUser = API + "/user"
	// APIUserLogin represents the API to login by authentication
	APIUserLogin = APIUser + "/login"
	APIUserList  = APIUser + "/list"
	APIUserInfo  = APIUser + "/info"
)

const (
	APIRole       = API + "/role"
	APIRoleList   = APIRole + "/list"
	APIRoleCreate = APIRole + "/create"
	APIRoleUpdate = APIRole + "/update/:roleId"
)

const (
	APIConversation            = "/api/conversation"
	APIConversationList        = APIConversation + "/list"
	APIConversationInfo        = APIConversation + "/:conversationId"
	APIMessageFeedback         = APIConversation + "/message_feedback"
	APIConversationBatchDelete = APIConversation + "/delete/batch"
	APIConversationWS          = APIConversation + "/ws"
	APIConversationBase        = APIConversation + "/base"
)

const (
	APICode         = "/api/code"
	APICodeGenerate = APICode + "/generate"
)

const (
	APILLM     = "/api/llm"
	APILLMList = APILLM + "/list"
)

const (
	// API represents the group of API
	API = "/api"
)

const (
	APIHealth = API + "/health"
)

Types

type AuthConfiguration

type AuthConfiguration struct {
	JwtKey    string `mapstructure:"jwt-key" json:"jwtKey"`
	Expires   uint   `mapstructure:"expires" json:"expires"`
	RuleTable string `mapstructure:"rule-table" json:"ruleTable"`
}

type Configuration

type Configuration struct {
	System   SystemConfiguration   `mapstructure:"system" json:"system"`
	Logs     LogsConfiguration     `mapstructure:"logs" json:"logs"`
	Database DatabaseConfiguration `mapstructure:"database" json:"database"`
	Auth     AuthConfiguration     `mapstructure:"auth" json:"auth"`
	Consul   ConsulConfiguration   `mapstructure:"consul" json:"consul"`
}

Configuration represents the composition of yml settings. Viper has a built-in mapstructure, and the yml file uses "-" to distinguish words.

func LoadAppConfig

func LoadAppConfig(filename string) (*Configuration, error)

LoadAppConfig reads the settings written to the yml file

type ConsulConfiguration

type ConsulConfiguration struct {
	Address string `mapstructure:"address" json:"address"`
	Port    int    `mapstructure:"port" json:"port"`
}

type DatabaseConfiguration

type DatabaseConfiguration struct {
	Dialect     string `mapstructure:"dialect" json:"dialect"`
	Username    string `mapstructure:"username" json:"username"`
	Password    string `mapstructure:"password" json:"password"`
	Dbname      string `mapstructure:"dbname" json:"dbname"`
	Host        string `mapstructure:"host" json:"host"`
	Port        int    `mapstructure:"port" json:"port"`
	Query       string `mapstructure:"query" json:"query"`
	LogMode     bool   `mapstructure:"log-mode" json:"logMode"`
	TablePrefix string `mapstructure:"table-prefix" json:"tablePrefix"`
	Charset     string `mapstructure:"charset" json:"charset"`
	Collation   string `mapstructure:"collation" json:"collation"`
	Migration   bool   `mapstructure:"migration" json:"migration"`
	InitData    bool   `mapstructure:"init-data" json:"initData"`
}

type LogsConfiguration

type LogsConfiguration struct {
	Encoding   string        `mapstructure:"encoding" json:"encoding"`
	Level      zapcore.Level `mapstructure:"level" json:"level"`
	Path       string        `mapstructure:"path" json:"path"`
	MaxSize    int           `mapstructure:"max-size" json:"maxSize"`
	MaxBackups int           `mapstructure:"max-backups" json:"maxBackups"`
	MaxAge     int           `mapstructure:"max-age" json:"maxAge"`
	Compress   bool          `mapstructure:"compress" json:"compress"`
}

type SystemConfiguration

type SystemConfiguration struct {
	ApiVersion  string `mapstructure:"api-version" json:"apiVersion"`
	WaitTimeout int    `mapstructure:"wait-timeout" json:"waitTimeout"`
}