api

Documentation

Index

• func DebugFromContext(ctx context.Context) bool
• func DebugToContext(production bool) func(next http.Handler) http.Handler
• func OK() *successWrap
• func RemoteAddrFromContext(ctx context.Context) string
• func RemoteAddrToContext(next http.Handler) http.Handler
• func Send(w http.ResponseWriter, r *http.Request, rr ...interface{})
• func Success(success ...string) *successWrap
• type CallFrame
• type ErrorPayload

Functions

func DebugFromContext

func DebugFromContext(ctx context.Context) bool

DebugFromContext returns remote IP address from context

func DebugToContext

func DebugToContext(production bool) func(next http.Handler) http.Handler

Packs remote address to context

func OK

func OK() *successWrap

OK returns the default Success message

func RemoteAddrFromContext

func RemoteAddrFromContext(ctx context.Context) string

RemoteAddrFromContext returns remote IP address from context

func RemoteAddrToContext

func RemoteAddrToContext(next http.Handler) http.Handler

Packs remote address to context

func Send

func Send(w http.ResponseWriter, r *http.Request, rr ...interface{})

Send handles first non-nil (and non-empty) payload and encodes it or it's results (when fn)

See encode() for details

func Success

func Success(success ...string) *successWrap

Success returns a structured success message for API responses

Types

type CallFrame

type CallFrame struct {
	Function string `json:"function"`
	File     string `json:"file"`
	Line     int    `json:"line"`
}

type ErrorPayload

type ErrorPayload struct {
	Message   string                 `json:"message"`
	Context   map[string]interface{} `json:"context,omitempty"`
	Callstack []*CallFrame           `json:"callstack,omitempty"`
}