api

package

v0.0.0-...-ca83fcd Latest Latest Go to latest Published: Jun 20, 2022 License: Apache-2.0 Imports: 11 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

View Source

const APIKeyHeaderKey = "apikey"

APIKeyHeader in this header thr right api key should be inserted

View Source

var (
	ContextKeyOffset = contextKey("offset")
	ContextKeyLimit  = contextKey("limit")
)

func MetricsHandler(cfg MetricsConfig) func(next http.Handler) http.Handler

MetricsHandler creates a new directly usable handler

func Paginate(next http.Handler) http.Handler

Paginate is a middleware logic for populating the context with offset and limit values

func RoleCheck(allowedRoles []string) func(next http.Handler) http.Handler

RoleCheck implements a simple middleware handler for adding basic http auth to a route.

func SysAPIHandler(cfg SysAPIConfig) func(next http.Handler) http.Handler

SysAPIHandler creates a new directly usable handler

func TraceEnhancer(next http.Handler) http.Handler

TraceEnhancer is a middleware that will set the http method and url as operation-name of the top level span.

type MetricsConfig struct {
	// Skip particular requests from the handler
	SkipFunc func(r *http.Request) bool
}

MetricsConfig defining a handler for checking system id and api key

type SysAPIConfig struct {
	Apikey string
	// Skip particular requests from the handler
	SkipFunc func(r *http.Request) bool
}

SysAPIKey defining a handler for checking system id and api key