endpoints

Documentation

Index

• Constants
• func CheckError(w http.ResponseWriter, response interface{}) (bool, error)
• func Description(intro string, v version.Version) http.Handler
• func EncodeResponse(w http.ResponseWriter, response interface{}) error
• func Err(cause error, status int) error
• type Error
  • func (e Error) Error() string
  • func (e Error) MarshalJSON() ([]byte, error)
• type Route

Constants

const (
	ContentType     = "Content-Type"
	ApplicationJSON = "application/json"
)

Functions

func CheckError

func CheckError(w http.ResponseWriter, response interface{}) (bool, error)

func Description

func Description(intro string, v version.Version) http.Handler

func EncodeResponse

func EncodeResponse(w http.ResponseWriter, response interface{}) error

EncodeResponse encodes a generic response

func Err

func Err(cause error, status int) error

Err wraps a cause with a status code

Types

type Error

type Error struct {
	Cause  error
	Status int
}

Error is a wrapper struct that provides HTTP Status code to an error

func (Error) Error

func (e Error) Error() string

func (Error) MarshalJSON

func (e Error) MarshalJSON() ([]byte, error)

MarshalJSON satisfies json.Marshaler

type Route

type Route struct {
	Path    string
	Method  string
	Handler http.Handler
}

Route contains endpoint information