api

package

v0.0.0-...-b146d40 Latest Latest Go to latest Published: May 1, 2020 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

API represents a Rest API instance of a ALoLStats instance

func NewAPI(cfg config.API, prefix string) (*API, error)

NewAPI creates a new Rest API instance

func NewAPICustom(cfg config.API, prefix string, router router) (*API, error)

NewAPICustom creates a new Rest API instance with a custom router

func (a *API) AttachModuleDelete(path string, f func(http.ResponseWriter, *http.Request))

AttachModuleDelete registers a new DELETE handler for the API

func (a *API) AttachModuleGet(path string, f func(http.ResponseWriter, *http.Request))

AttachModuleGet registers a new GET handler for the API

func (a *API) AttachModulePost(path string, f func(http.ResponseWriter, *http.Request))

AttachModulePost registers a new POST handler for the API

func (a *API) AttachModulePut(path string, f func(http.ResponseWriter, *http.Request))

AttachModulePut registers a new PUT handler for the API

func (a *API) Init() error

Init the API instance

func (a *API) Run(ctx context.Context) error

Run the REST API (blocking)