rest

package

v0.0.0-...-cd0f3b4 Latest Latest Go to latest Published: Apr 6, 2016 License: GPL-2.0 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 rest implements the REST server for GlusterD

This section is empty.

This section is empty.

func SendHTTPError(rw http.ResponseWriter, statusCode int, errMsg string)

SendHTTPError is to report error back to the client

func SendHTTPResponse(w http.ResponseWriter, statusCode int, rsp interface{})

SendHTTPResponse to send response back to the client

type APIError struct {
	Error string
}

APIError is the placeholder for error string to report back to the client

type GDRest struct {
	Routes *mux.Router
	// contains filtered or unexported fields
}

GDRest is the GlusterD Rest server

func New() *GDRest

New returns a GDRest object which can listen on the configured address

func (r *GDRest) Listen() error

Listen begins the GlusterD Rest server

func (r *GDRest) SetRoutes(routes Routes)

SetRoutes adds the given routes to the GlusterD Rest server

func (r *GDRest) Stop()

Stop stops the GlusterD Rest server

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

Route models a route to be set on the GlusterD Rest server This route style comes from the tutorial on http://thenewstack.io/make-a-restful-json-api-go/

type Routes []Route

Routes is a table of many Route's