httpapi

type Normalize ¶

type Normalize struct {
}

Normalize Middleware: It implements the ServeHTTP interface for negroni middleware. The function is to evaluate the incoming request and validate/store the required headers

func NewNormalize() *Normalize

func (n Normalize) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)

type Request ¶

type Request struct {
	Headers         http.Header
	RouteParameters httprouter.Params
	Body            io.ReadSeeker
	Host            string
	Path            string
	Method          string
	Query           url.Values
	Client          *http.Client
}

Request provides a starndardized way of accessing incoming requests We standardize information both for receiving and sending.

Context: It implements context functions for the context.Context package so that the rest of gobl can access the standardized parameters via the http.Request context

func NewRequest(host, path, method string) *Request

func RequestFromContext(ctx context.Context) *Request

func (r *Request) JsonBody(decodeTo interface{}) error

func (r *Request) Send(s keys.Signer) (*Response, error)

func (r *Request) SetBody(body interface{}) error

func (r *Request) String() string

type Response ¶

type Response struct {
	// Data is API payload
	Data map[string]interface{} `json:"data,omitempty"`

	// Error holds any errors that were encountered processing the request
	Error error `json:"-"`

	// HTTPCode allows individual handlers to indiciate the appropriate http status code to return
	HTTPCode int `json:"-"`
}

Response is the standardized response format sent from the API

func (r *Response) Write(rw http.ResponseWriter)

type Route ¶

type Route struct {
	// Method is the HTTP method to listen on
	Method string

	// Path indictes the URL path. Wildcards in the form of :segment are supported
	// For more information see:
	// https://github.com/julienschmidt/httprouter
	Path string

	// Handler to use for this route
	Handler RouteHandler
}

Route defines a single endpoint

type RouteHandler ¶

type RouteHandler func(*Request, httprouter.Params) Response

RouteHandler is the definition functions must meet to handle incoming requests

type Server ¶

type Server struct {
	// contains filtered or unexported fields
}

Server handles accepting and replying to API requests

func New(routes []Route) *Server

func (s *Server) Start(c config.Server, shutdown func())