restserializer

README

RESTSerializer package

RESTSerializer is a golang REST serializer helper. You can create your own entity serializer interface and implement this one.

Documentation

Index

• Variables
• func HttpErrorRender(err error, w http.ResponseWriter, resource string)
• func RenderError(err error, w http.ResponseWriter, statusCode int, resource string)
• func WriteContentType(w http.ResponseWriter)
• type ErrBody
• type Error
• type ErrorSerializer

Variables

var ErrBadRequest = errors.New("error bad request")

var ErrConflict = errors.New("error conflict")

var ErrForbidden = errors.New("error access forbidden")

var ErrNotFound = errors.New("error not found")

var ErrUnknown = errors.New("error unknown")

Functions

func HttpErrorRender

func HttpErrorRender(err error, w http.ResponseWriter, resource string)

func RenderError

func RenderError(err error, w http.ResponseWriter, statusCode int, resource string)

func WriteContentType

func WriteContentType(w http.ResponseWriter)

Types

type ErrBody

type ErrBody struct {
	Error Error `json:"error"`
}

type Error

type Error struct {
	Resource   string `json:"resource,omitempty"`
	Message    string `json:"message"`
	StatusCode int    `json:"statusCode"`
	Status     string `json:"status"`
}

type ErrorSerializer

type ErrorSerializer interface {
	RenderError(err error, w http.ResponseWriter, statusCode int)
	WriteContentType(w http.ResponseWriter)
}