api

Documentation

Index

• func Respond(w http.ResponseWriter, r Response) error
• type Response

Functions

func Respond

func Respond(w http.ResponseWriter, r Response) error

Types

type Response

type Response struct {
	// Shared common fields.
	Status  int               `json:"-"`
	Headers map[string]string `json:"-"`
	Action  string            `json:"action,omitempty"`

	// Success specific fields.
	Data interface{} `json:"data,omitempty"`
	Meta interface{} `json:"meta,omitempty"`

	// Failure specific fields.
	Message string            `json:"message,omitempty"`
	Errors  map[string]string `json:"errors,omitempty"`
}