jsonresp

Documentation

Index

• func ReadResponse(r io.Reader, v interface{}) error
• func WriteError(w http.ResponseWriter, error string, code int)
• func WriteResponse(w http.ResponseWriter, data interface{}, code int)
• type Error
  • func NewError(code int, message string) *Error
  • func (e *Error) Error() string
• type Response

Functions

func ReadResponse

func ReadResponse(r io.Reader, v interface{}) error

ReadResponse reads a JSON response, and unmarshals the supplied data.

func WriteError

func WriteError(w http.ResponseWriter, error string, code int)

WriteError encodes the supplied error in a response, and writes to w.

func WriteResponse

func WriteResponse(w http.ResponseWriter, data interface{}, code int)

WriteResponse encodes the supplied data in a response, and writes to w.

Types

type Error

type Error struct {
	Code    int    `json:"code,omitempty"`
	Message string `json:"message,omitempty"`
}

Error describes an error condition.

func NewError

func NewError(code int, message string) *Error

NewError returns an error that contains the given code and message.

func (*Error) Error

func (e *Error) Error() string

type Response

type Response struct {
	Data  interface{} `json:"data,omitempty"`
	Error *Error      `json:"error,omitempty"`
}

Response is the top level container of all of our REST API responses.