api

package

v0.0.0-...-74d5043 Latest Latest Go to latest Published: Feb 18, 2022 License: AGPL-3.0 Imports: 9 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.

View Source

var (
	ErrNoHostInConfig = errors.New("no-api-host-in-config")
	ErrNoPortInConfig = errors.New("no-api-port-in-config")
)

func InfosHandler(ctx context.Context) http.Handler

InfosHandler will handle the infos route swagger:route GET /infos Miscellaneous infos

Produces:

Schemes: http, https

Responses:

default: GenericError
200: Infos

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

func New(ctx context.Context, c Config) (*API, error)

func (s *API) Run() error

type Config struct {
	Host string `mapstructure:"host"`
	Port int    `mapstructure:"port"`
}

func (c Config) Validate() error

Path	Synopsis
utils
v1