api

Documentation

Index

• func StartAPI(apiConfig string) error
• type ConfDB
• type ConfSrv
• type Configuration

Functions

func StartAPI

func StartAPI(apiConfig string) error

@host api-dev.yulmails.io @BasePath / @tag.name entity @tag.name abuse @tag.name conservation

Types

type ConfDB

type ConfDB struct {
	// Username of the database
	Username string `yaml:"username"`
	// Password of the database
	Password string `yaml:"password"`
	// Host of the database
	Host string `yaml:"host"`
	// Port of the database
	Port int `yaml:"port"`
	// Name of the database to use
	Name string `yaml:"name"`
}

ConfDB is the database configuration

type ConfSrv

type ConfSrv struct {
	// Port to listen on
	Port int `yaml:"port"`
}

type Configuration

type Configuration struct {
	// Database configuration
	Database ConfDB `yaml:"database"`
	// Server configuration
	Server ConfSrv `yaml:"server"`
}

Configuration is the global configuration of the API server