api

Documentation

Index

• type Instance
  • func New() *Instance
  • func (i *Instance) SaveRouteList() error
  • func (i *Instance) Stale()
  • func (i *Instance) Start(nl net.Listener, address string) error

Types

type Instance

type Instance struct {
	Echo       *echo.Echo
	RouteGroup map[string]*echo.Group
	Version    string
	// contains filtered or unexported fields
}

Instance defines web framework API instance

func New

func New() *Instance

New creates new API server instance and start the server immediately

func (*Instance) SaveRouteList

func (i *Instance) SaveRouteList() error

SaveRouteList will save all registedred route list into json file in the user home directory

func (*Instance) Stale

func (i *Instance) Stale()

Stale to shutdown the REST API Server

func (*Instance) Start

func (i *Instance) Start(nl net.Listener, address string) error

Start start up the REST API Server