apibase

package

v0.0.0-...-822ec7e Latest Latest Go to latest Published: Oct 12, 2021 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 Base struct {
	ServiceName string
	Healthy     bool
	Version     string
	BuildInfo   string
	Router      *mux.Router
}

Base holds a standard set of values for all services & APIs

func New(name, ver, info string, healthy bool, rootRouter *mux.Router) *Base

New creates and returns a new Base API instance

func (api *Base) HealthCheck(resp http.ResponseWriter, req *http.Request)

HealthCheck - Simple health check endpoint, returns 204 when healthy

func (api *Base) Send(data interface{}, resp http.ResponseWriter)

Send is a trivial helper for returning JSON over the API

func (api *Base) Status(resp http.ResponseWriter, req *http.Request)

Status - status information data - Remove if you like