api

package

v1.2.0 Latest Latest Go to latest Published: Feb 29, 2024 License: AGPL-3.0 Imports: 37 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.

func NewMetricsRouter() *http.ServeMux

NewRouter creates metrics router

func NewRouter(conf *config.Config) *http.ServeMux

NewRouter creates router with declared routes

func Shutdown()

Shutdown set API as stopped

func Start()

Start set API as started

type Info struct {
	Version   string `json:"version"`
	Authority string `json:"authority"`
	VAPID     string `json:"vapid"`
}

Info API informations model structure.

type Route struct {
	Path        string
	Handler     http.Handler
	Middlewares []middleware.Middleware
}

Route is the structure of an HTTP route definition

type Routes []Route

Routes is a list of Route