restapi

package

v0.0.0-...-4a54890 Latest Latest Go to latest Published: Nov 12, 2020 License: Apache-2.0 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.

View Source

var DBClient dbclient.IBoltClient

DBClient instance for accessing the underlying BoltDB, be it the real one or a mock.

View Source

var MessagingClient messaging.IMessagingClient

MessagingClient instance

func GetAccount(w http.ResponseWriter, r *http.Request)

GetAccount loads an account instance, including a quote and an image URL using sub-services.

func HealthCheck(w http.ResponseWriter, r *http.Request)

HealthCheck will return OK if the underlying BoltDB is healthy. At least healthy enough for demoing purposes.

func NewRouter() *mux.Router

NewRouter creates a mux.Router pointer.

func SetHealthyState(w http.ResponseWriter, r *http.Request)

SetHealthyState can be used fake health problems.

type Route struct {
	Name        string
	Method      string
	Pattern     string
	HandlerFunc http.HandlerFunc
}

Defines a single route, e.g. a human readable name, HTTP method and the pattern the function that will execute when the route is called.

type Routes []Route

Defines the type Routes which is just an array (slice) of Route structs.