httputil

Documentation

Index

• type DoOptions
• type Error
  • func (e *Error) Error() string
• type HTTPClient
  • func NewHTTPClient() *HTTPClient
  • func (c *HTTPClient) Do(method, path string, doOptions *DoOptions) (*http.Response, error)
• type HTTPResponse

Types

type DoOptions

type DoOptions struct {
	Data      interface{}
	Context   context.Context
	Headers   map[string]string
	ForceJSON bool
}

DoOptions are options passed to the HTTPClient.Do function

type Error

type Error struct {
	Status  int
	Message string
}

Error is a custom HTTP error structure

func (*Error) Error

func (e *Error) Error() string

Error implemented to match Error interface

type HTTPClient

type HTTPClient struct {
	HTTPClient *http.Client
}

HTTPClient returns an HTTP Client struct that can execute HTTP requests

func NewHTTPClient

func NewHTTPClient() *HTTPClient

NewHTTPClient returns a new HTTP Client

func (*HTTPClient) Do

func (c *HTTPClient) Do(method, path string, doOptions *DoOptions) (*http.Response, error)

Do executes the given HTTP request and returns the HTTP Response

type HTTPResponse

type HTTPResponse struct {
	Raw  *http.Response
	Body string
}

HTTPResponse houses respnse object