httpresponse

Documentation

Index

• Constants
• func Empty(w http.ResponseWriter, code int)
• func Error(w http.ResponseWriter, code int, reason ...string) error
• func JSON(w http.ResponseWriter, v interface{}, code int, indent uint) error
• func Text(w http.ResponseWriter, v string, code int)
• type ErrorResponse

Constants

const (
	ContentTypeKey   = "Content-Type"
	ContentLengthKey = "Content-Length"
	ContentTypeJSON  = "application/json"
	ContentTypeText  = "text/plain"
)

Functions

func Empty

func Empty(w http.ResponseWriter, code int)

Empty is a utility function to serve an empty response

func Error

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

Error is a utility function to serve a JSON error notice

func JSON

func JSON(w http.ResponseWriter, v interface{}, code int, indent uint) error

JSON is a utility function to serve an arbitary object as JSON

func Text

func Text(w http.ResponseWriter, v string, code int)

Text is a utility function to serve plaintext

Types

type ErrorResponse

type ErrorResponse struct {
	Code   int    `json:"code"`
	Reason string `json:"reason,omitempty"`
}

ErrorResponse is a generic error response which is served as JSON using the ServeError method