httpapi

README

httpapi

Writing HTTP API services in Go. Still in progress, check back later for better API and documentation.

Documentation

Index

• type Handler
  • func (h Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type RequestParams

Types

type Handler

type Handler struct {
	// RequestStruct is a struct to store the fields of request
	// paramemters, passed as JSON from the client.
	RequestStruct interface{}
}

Handler handles a single API endpoint

func (Handler) ServeHTTP

func (h Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

FIXME: best way to report errors in ServerHTTP?

type RequestParams

type RequestParams interface {
	// HandleRequest is called when a request comes in. POST body will
	// be decoded into the receiver; returned value will be encoded to
	// JSON before responding to the client.
	// FIXME: pre-define errors for appropriate HTTP codes (404, 500) ...
	HandleRequest() (interface{}, error)
}