httpsimple

Documentation

Index

• Constants
• func DefaultContentTypeBodyType(bt string) string
• func Do(ctx context.Context, req Request) (*http.Response, error)
• func DoMore(ctx context.Context, req Request) ([]byte, *http.Response, error)
• type Client
  • func NewClient(httpClient *http.Client, baseURL string) Client
  • func (sc *Client) Do(req Request) (*http.Response, error)
  • func (sc *Client) DoUnmarshalJSON(req Request, resBody any) ([]byte, *http.Response, error)
  • func (sc *Client) Get(reqURL string) (*http.Response, error)
• type Request
  • func NewRequest() Request
  • func (req *Request) BodyBytes() ([]byte, error)
  • func (req *Request) FullURL() (*url.URL, error)
  • func (req *Request) HTTPRequest(ctx context.Context) (*http.Request, error)
  • func (req *Request) Inflate()

Constants

const (
	BodyTypeFile = "file" // Body must be an `io.Reader`. Used for streaming.
	BodyTypeForm = "form"
	BodyTypeJSON = "json"
	BodyTypeXML  = "xml"
)

Functions

func DefaultContentTypeBodyType

func DefaultContentTypeBodyType(bt string) string

func Do

func Do(ctx context.Context, req Request) (*http.Response, error)

func DoMore

func DoMore(ctx context.Context, req Request) ([]byte, *http.Response, error)

Types

type Client

type Client struct {
	BaseURL    string     // TODO: See if we can do this within Transport: https://gist.github.com/epelc/cc286ad0fd7878fb176a89f2af1177b6
	Query      url.Values // Add If Not Exists
	HTTPClient *http.Client
}

Client provides a simple interface to making HTTP requests using `net/http`.

func NewClient

func NewClient(httpClient *http.Client, baseURL string) Client

func (*Client) Do

func (sc *Client) Do(req Request) (*http.Response, error)

func (*Client) DoUnmarshalJSON

func (sc *Client) DoUnmarshalJSON(req Request, resBody any) ([]byte, *http.Response, error)

func (*Client) Get

func (sc *Client) Get(reqURL string) (*http.Response, error)

type Request

type Request struct {
	Method        string
	URL           string
	Query         url.Values
	Headers       http.Header
	Body          any
	BodyType      string
	AddXMLDocType bool // only used if `Body` is a struct.
	Cookies       []http.Cookie
}

func NewRequest

func NewRequest() Request

func (*Request) BodyBytes

func (req *Request) BodyBytes() ([]byte, error)

func (*Request) FullURL

func (req *Request) FullURL() (*url.URL, error)

func (*Request) HTTPRequest

func (req *Request) HTTPRequest(ctx context.Context) (*http.Request, error)

func (*Request) Inflate

func (req *Request) Inflate()