api

Documentation

Index

• Variables
• func FormValues(r *http.Request, params interface{}, validationRules []*v.FieldRules) error
• type Handler
  • func (h Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Response
• type ResponseInfo
• type StatusError
  • func (se StatusError) Error() string

Variables

var BuildJSONResponse = func(response ResponseInfo) ([]byte, error) {
	return json.MarshalIndent(&response, "", "  ")
}

BuildJSONResponse allows implementers to control the json response form from the api

var IgnoredFormFields []string

IgnoredFormFields are ignored by FormValues() when checking for extraneous fields

var Log = func(*http.Request, *Response, error) {}

Log allows logging of events and errors

var ResponseHeaders map[string]string

ResponseHeaders are returned with each response

var TraceEnabled = false

TraceEnabled Attaches a trace field to the JSON response when enabled.

Functions

func FormValues

func FormValues(r *http.Request, params interface{}, validationRules []*v.FieldRules) error

Types

type Handler

type Handler func(r *http.Request) Response

Handler handles API requests

func (Handler) ServeHTTP

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

type Response

type Response struct {
	Status      int
	Data        interface{}
	RedirectURL string
	Error       error
}

Response is returned by API handlers

type ResponseInfo

type ResponseInfo struct {
	Success bool        `json:"success"`
	Error   *string     `json:"error"`
	Data    interface{} `json:"data"`
	Trace   []string    `json:"_trace,omitempty"`
}

http://choly.ca/post/go-json-marshalling/

type StatusError

type StatusError struct {
	Status int
	Err    error
}

StatusError represents an error with an associated HTTP status code.

func (StatusError) Error

func (se StatusError) Error() string