jsonresp

README

JSON Response

The json-resp package contains a small set of functions that are used to marshall and unmarshall response data and errors in JSON format.

Quick Start

Install the CircleCI Local CLI. See the Continuous Integration section below for more detail.

To build and test:

circleci build

Continuous Integration

This package uses CircleCI for Continuous Integration (CI). It runs automatically on commits and pull requests involving a protected branch. All CI checks must pass before a merge to a proected branch can be performed.

The CI checks are typically run in the cloud without user intervention. If desired, the CI checks can also be run locally using the CircleCI Local CLI.

Documentation

Index

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

Functions

func ReadError

func ReadError(r io.Reader) error

ReadError attempts to unmarshal JSON-encoded error details from the supplied reader. It returns nil if an error could not be parsed from the response, or if the parsed error was nil.

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) error

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

func WriteResponse

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

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

func WriteResponsePage

func WriteResponsePage(w http.ResponseWriter, data interface{}, pd *PageDetails, code int) error

WriteResponsePage encodes the supplied data in a paged JSON 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 PageDetails

type PageDetails struct {
	Prev      string `json:"prev,omitempty"`
	Next      string `json:"next,omitempty"`
	TotalSize int    `json:"totalSize,omitempty"`
}

PageDetails specifies paging information.

func ReadResponsePage

func ReadResponsePage(r io.Reader, v interface{}) (pd *PageDetails, err error)

ReadResponsePage reads a paged JSON response, and unmarshals the supplied data.

type Response

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

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