api

Documentation

Index

• type AdderAdminResources
• type AdminRegister
• type Config
  • func NewConfig() *Config
  • func (c *Config) GetURL() string
• type ResourcesAdder
• type Server
  • func NewServer(admin AdminRegister, apps ...ResourcesAdder) *Server
  • func (s *Server) Init()
  • func (s *Server) Run()

Types

type AdderAdminResources

type AdderAdminResources interface {
	AddResource(value interface{}, config ...*admin.Config) *admin.Resource
}

AdderAdminResources adds resources to the admin

type AdminRegister

type AdminRegister interface {
	RegisterApp(a interface{ ResourcesAdder })
	MountTo(mountTo string, mux *http.ServeMux)
}

AdminRegister is the app register interface

type Config

type Config struct {
	Host    string
	Port    uint
	IsProd  bool
	LogPath string
}

Config is the api configuration struct.

func NewConfig

func NewConfig() *Config

NewConfig returns the configuration object.

func (*Config) GetURL

func (c *Config) GetURL() string

GetURL returns the API URL

type ResourcesAdder

type ResourcesAdder interface {
	AddAdminResources(admin interface{ AdderAdminResources })
}

ResourcesAdder add the app admin resources

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server is the server object

func NewServer

func NewServer(admin AdminRegister, apps ...ResourcesAdder) *Server

NewServer returns a new admin object.

func (*Server) Init

func (s *Server) Init()

Init initializes the server and the admin

func (*Server) Run

func (s *Server) Run()

Run the server