restup

Documentation

Index

• type RequestError
  • func (e RequestError) Error() string
• type RestUp
  • func NewRestUp(baseURL string, token string) *RestUp
  • func (rup *RestUp) AddHeader(name, value string)
  • func (rup *RestUp) Get(action string, out interface{}) error
  • func (rup *RestUp) Post(action string, query interface{}, out interface{}) error
  • func (rup *RestUp) TransportIntercept(rt http.RoundTripper)

Types

type RequestError

type RequestError struct {
	Method    string
	URL       string
	Body      string
	HTTPError error
}

RequestError returns the error context of a failed POST call

func (RequestError) Error

func (e RequestError) Error() string

type RestUp

type RestUp struct {
	// contains filtered or unexported fields
}

RestUp ...

func NewRestUp

func NewRestUp(baseURL string, token string) *RestUp

NewRestUp returns a new RestUp with the authentication token encoded

func (*RestUp) AddHeader

func (rup *RestUp) AddHeader(name, value string)

AddHeader allows additional headers to be added to the API request

func (*RestUp) Get

func (rup *RestUp) Get(action string, out interface{}) error

Get performs the requested API Get returning the results as JSON

func (*RestUp) Post

func (rup *RestUp) Post(action string, query interface{}, out interface{}) error

Post performs the requested API Post returning the results as JSON

func (*RestUp) TransportIntercept

func (rup *RestUp) TransportIntercept(rt http.RoundTripper)

TransportIntercept allows you to supply a custom HTTP client, useful for testing