api

package

v0.0.8 Latest Latest Go to latest Published: Apr 24, 2022 License: MIT 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

Repository

github.com/benc-uk/food-truck

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Base ¶

type Base struct {
	Healthy bool   `json:"healthy"` // Whether the server is healthy
	Version string `json:"version"` // Version of the API
	Name    string `json:"name"`    // Name of this API	or web service
}

This is intended to be wrapped & extended by the application API struct

func (*Base) AddHealth ¶

func (b *Base) AddHealth(r *mux.Router)

AddHealth adds a health check endpoint to the API

func (*Base) AddLogging ¶

func (b *Base) AddLogging(r *mux.Router)

Add logging middleware to the router in Apache Common Log Format.

func (*Base) AddMetrics ¶

func (b *Base) AddMetrics(r *mux.Router)

AddMetrics adds Prometheus metrics to the router

func (*Base) AddStatus ¶

func (b *Base) AddStatus(r *mux.Router)

AddStatus adds a status & info endpoint to the API

func (*Base) CORSHandler ¶

func (b *Base) CORSHandler(origins []string, r *mux.Router) http.Handler

CORSHandler sets up CORS using http.Handler it can not be added as middleware

type Error ¶

type Error struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

func (*Error) Error ¶

func (e *Error) Error() string

type Status ¶

type Status struct {
	Hostname  string `json:"hostname"`
	Uptime    string `json:"uptime"`
	GoVersion string `json:"goVersion"`
	*Base
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL