icchttp

package

v0.0.0-...-bd60060 Latest Latest Go to latest Published: Oct 12, 2023 License: MIT 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

Package icchttp contains helper function to handle http requests.

The handers are defined by its own package (icc, applause...).

View Source

const (
	// Path is the basic path for all handlers of this service.
	Path = "/system/icc"
)

This section is empty.

func AuthMiddleware(next http.Handler, auth Authenticater) http.Handler

AuthMiddleware checks the user id of the request.

func Error(w http.ResponseWriter, err error)

Error sends an error message to the client as json-message.

If the error does not have a Type() string message, it is handled as 500er. In other case, it is handled as 400er.

func ErrorNoStatus(w io.Writer, err error)

ErrorNoStatus is like Error(), but does not write a status message.

func HandleHealth(mux *http.ServeMux)

HandleHealth returns 200 (if the service is running).

func HealthClient(ctx context.Context, useHTTPS bool, host, port string, insecure bool) error

HealthClient sends a http request to a server to fetch the health status.

type Authenticater interface {
	Authenticate(http.ResponseWriter, *http.Request) (context.Context, error)
	FromContext(context.Context) int
}

Authenticater knowns how to authenticate a request.