response

Documentation

Index

• func Accepted(w http.ResponseWriter, message string)
• func Created(w http.ResponseWriter, data interface{})
• func Error(w http.ResponseWriter, errs error)
• func Errors(status int, w http.ResponseWriter, errs []errors.Error)
• func File(w http.ResponseWriter, file io.Reader, path string)
• func OK(w http.ResponseWriter, data interface{})
• func OKMeta(w http.ResponseWriter, data interface{}, meta Meta)
• func Send(status int, w http.ResponseWriter, data interface{})
• func SendError(status int, w http.ResponseWriter, errs []errors.Error)
• func SendMeta(status int, w http.ResponseWriter, data interface{}, meta Meta)
• type Body
• type ErrorInfo
• type Meta

Functions

func Accepted

func Accepted(w http.ResponseWriter, message string)

func Created

func Created(w http.ResponseWriter, data interface{})

func Error

func Error(w http.ResponseWriter, errs error)

func Errors

func Errors(status int, w http.ResponseWriter, errs []errors.Error)

func File

func File(w http.ResponseWriter, file io.Reader, path string)

func OK

func OK(w http.ResponseWriter, data interface{})

func OKMeta

func OKMeta(w http.ResponseWriter, data interface{}, meta Meta)

func Send

func Send(status int, w http.ResponseWriter, data interface{})

func SendError

func SendError(status int, w http.ResponseWriter, errs []errors.Error)

func SendMeta

func SendMeta(status int, w http.ResponseWriter, data interface{}, meta Meta)

Types

type Body

type Body struct {
	Data    interface{} `json:"data,omitempty"`
	Errors  []ErrorInfo `json:"errors,omitempty"`
	Message string      `json:"message,omitempty"`
	Meta    Meta        `json:"meta"`
}

type ErrorInfo

type ErrorInfo struct {
	Message string `json:"message"`
	Field   string `json:"field,omitempty"`
}

type Meta

type Meta struct {
	HTTPStatus int `json:"http_status"`
	Limit      int `json:"limit,omitempty"`
	Offset     int `json:"offset,omitempty"`
	Total      int `json:"total,omitempty"`
}