httpx

Documentation

Index

• Variables
• func Do(client *http.Client, request *http.Request) (*http.Response, error)
• func SetDebug(enabled bool)
• func SetRequestor(requestor Requestor)
• type MockRequestor
  • func NewMockRequestor(mocks map[string][]MockResponse) *MockRequestor
  • func (r *MockRequestor) Clone() *MockRequestor
  • func (r *MockRequestor) Do(client *http.Client, request *http.Request) (*http.Response, error)
  • func (r *MockRequestor) HasUnused() bool
  • func (r *MockRequestor) MarshalJSON() ([]byte, error)
  • func (r *MockRequestor) UnmarshalJSON(data []byte) error
• type MockResponse
  • func NewMockResponse(status int, body string) MockResponse
  • func (m MockResponse) Make(request *http.Request) *http.Response
• type Requestor
• type Trace
  • func DoTrace(client *http.Client, method string, url string, body io.Reader, ...) (*Trace, error)
  • func (t *Trace) String() string

Variables

var MockConnectionError = MockResponse{0, ""}

MockConnectionError mocks a connection error

Functions

func Do

func Do(client *http.Client, request *http.Request) (*http.Response, error)

Do makes the given HTTP request using the current requestor

func SetDebug

func SetDebug(enabled bool)

func SetRequestor

func SetRequestor(requestor Requestor)

SetRequestor sets the requestor used by Request

Types

type MockRequestor

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

func NewMockRequestor

func NewMockRequestor(mocks map[string][]MockResponse) *MockRequestor

func (*MockRequestor) Clone

func (r *MockRequestor) Clone() *MockRequestor

Clone returns a clone of this requestor

func (*MockRequestor) Do

func (r *MockRequestor) Do(client *http.Client, request *http.Request) (*http.Response, error)

func (*MockRequestor) HasUnused

func (r *MockRequestor) HasUnused() bool

HasUnused returns true if there are unused mocks leftover

func (*MockRequestor) MarshalJSON

func (r *MockRequestor) MarshalJSON() ([]byte, error)

func (*MockRequestor) UnmarshalJSON

func (r *MockRequestor) UnmarshalJSON(data []byte) error

type MockResponse

type MockResponse struct {
	Status int    `json:"status" validate:"required"`
	Body   string `json:"body" validate:"required"`
}

func NewMockResponse

func NewMockResponse(status int, body string) MockResponse

NewMockResponse creates a new mock response

func (MockResponse) Make

func (m MockResponse) Make(request *http.Request) *http.Response

type Requestor

type Requestor interface {
	Do(*http.Client, *http.Request) (*http.Response, error)
}

Requestor is anything that can make an HTTP request with a client

var DefaultRequestor Requestor = defaultRequestor{}

DefaultRequestor is the default HTTP requestor

type Trace

type Trace struct {
	Request       *http.Request
	RequestTrace  []byte
	Response      *http.Response
	ResponseTrace []byte
	ResponseBody  []byte
	StartTime     time.Time
	EndTime       time.Time
}

Trace holds the complete trace of an HTTP request/response

func DoTrace

func DoTrace(client *http.Client, method string, url string, body io.Reader, headers map[string]string) (*Trace, error)

DoTrace makes the given request saving traces of the complete request and response

func (*Trace) String

func (t *Trace) String() string