http

Documentation

Index

• type Client
  • func NewClient(c *http.Client, modifiers ...modifier.Modifier) *Client
  • func (c *Client) Delete(url string) error
  • func (c *Client) Do(req *http.Request) (*http.Response, error)
  • func (c *Client) Get(url string, v ...interface{}) error
  • func (c *Client) GetAndIteratePagination(endpoint string, v interface{}) error
  • func (c *Client) Head(url string) error
  • func (c *Client) Post(url string, v ...interface{}) error
  • func (c *Client) Put(url string, v ...interface{}) error
• type Error
  • func (e *Error) Error() string
  • func (e *Error) String() string

Types

type Client

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

Client is a util for common HTTP operations, such Get, Head, Post, Put and Delete. Use Do instead if those methods can not meet your requirement

func NewClient

func NewClient(c *http.Client, modifiers ...modifier.Modifier) *Client

NewClient creates an instance of Client. Use net/http.Client as the default value if c is nil. Modifiers modify the request before sending it.

func (*Client) Delete

func (c *Client) Delete(url string) error

Delete ...

func (*Client) Do

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

Do ...

func (*Client) Get

func (c *Client) Get(url string, v ...interface{}) error

Get ...

func (*Client) GetAndIteratePagination

func (c *Client) GetAndIteratePagination(endpoint string, v interface{}) error

GetAndIteratePagination iterates the pagination header and returns all resources The parameter "v" must be a pointer to a slice

func (*Client) Head

func (c *Client) Head(url string) error

Head ...

func (*Client) Post

func (c *Client) Post(url string, v ...interface{}) error

Post ...

func (*Client) Put

func (c *Client) Put(url string, v ...interface{}) error

Put ...

type Error

type Error struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

Error wrap HTTP status code and message as an error

func (*Error) Error

func (e *Error) Error() string

Error ...

func (*Error) String

func (e *Error) String() string

String wraps the error msg to the well formatted error message