http

Documentation

Index

• func CheckResponse(resp *http.Response) error
• type Client
  • func NewClient(baseURL string, options ...ClientOptionFunc) (*Client, error)
  • func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) (*http.Response, error)
  • func (c *Client) NewRequest(method, path string, body interface{}, options []ClientOptionFunc) (*http.Request, error)
• type ClientOptionFunc
  • func WithTimeout(timeout int) ClientOptionFunc
  • func WithToken(token string) ClientOptionFunc
• type ErrorResponse

Functions

func CheckResponse

func CheckResponse(resp *http.Response) error

CheckResponse checks the API response for errors, and returns them if present.

Types

type Client

type Client struct {

	// UserAgent is the user agent to include in HTTP requests.
	UserAgent string
	// contains filtered or unexported fields
}

func NewClient

func NewClient(baseURL string, options ...ClientOptionFunc) (*Client, error)

func (*Client) Do

func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) (*http.Response, error)

func (*Client) NewRequest

func (c *Client) NewRequest(method, path string, body interface{}, options []ClientOptionFunc) (*http.Request, error)

type ClientOptionFunc

type ClientOptionFunc func(*Client) error

ClientOptionFunc can be used to customize a new Restful API client.

func WithTimeout

func WithTimeout(timeout int) ClientOptionFunc

WithTimeout can be used to configure a custom timeout for requests.

func WithToken

func WithToken(token string) ClientOptionFunc

WithToken is an option for NewClient to set token

type ErrorResponse

type ErrorResponse struct {
	Body     []byte
	Response *http.Response
	Message  string
}