apiserver

package

v1.0.1238 Latest Latest Go to latest Published: Nov 1, 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

View Source

const (
	// RoutePathNodeBootstrapping the route path to get node bootstrapping data.
	RoutePathNodeBootstrapData string = "/getnodebootstrapdata"
)

This section is empty.

This section is empty.

type APIServer struct {
	Options *Options
}

APIServer contains the connections details required to run the api

func NewAPIServer(o *Options) (*APIServer, error)

NewAPIServer creates an APIServer object with defaults

func (api *APIServer) GetNodeBootstrapData(w http.ResponseWriter, r *http.Request)

GetNodeBootstrapConfig endpoint for getting node bootstrapping data.

func (api *APIServer) ListenAndServe(ctx context.Context) error

ListenAndServe wraps http.Server and provides context-based cancelation.

func (api *APIServer) NewRouter(ctx context.Context) *mux.Router

NewRouter returns a new router with defaults

type Options struct {
	Addr string
}

Options holds the options for the api server

type Result struct {
	Message string
	Error   error
}

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

Route the route specifics

type Routes []Route

Routes list of routes to be added to the server