requests

Documentation

Index

• type Builder
  • func New(endpoint string) Builder
• type Result

Types

type Builder

type Builder interface {
	WithContext(context.Context) Builder
	WithBody(io.Reader) Builder
	WithMethod(string) Builder
	WithHeaders(http.Header) Builder
	SetHeader(key, value string) Builder
	Do() Result
}

Builder allows users to construct a request and then execute the request via Do(). Do returns a Result which allows the user to get the body, unmarshal the body into an interface, or into a simplejson.Json.

func New

func New(endpoint string) Builder

New provides a new Builder for the given endpoint.

type Result

type Result interface {
	Error() error
	StatusCode() int
	Headers() http.Header
	Body() []byte
	UnmarshalInto(interface{}) error
	UnmarshalSimpleJSON() (*simplejson.Json, error)
}

Result is the result of a request created by a Builder