rest

README

rest

REST API client.

Just a wrapper over http.Client with better errors and JSON unmarshaling.

Installation

go get github.com/vtopc/go-rest

This will update yours go.mod file.

TODOs

• Configure linters
• Switch to https://github.com/json-iterator/go ? https://yalantis.com/blog/speed-up-json-encoding-decoding/

Documentation

Index

• func NewReqError(req *http.Request, wrappedErr error) error
• type APIError
  • func (e *APIError) Error() string
  • func (e *APIError) Unwrap() error
• type Client
  • func NewClient(client *http.Client) *Client
  • func (c *Client) Do(req *http.Request, v interface{}, expectedStatusCodes ...int) error
• type HTTPClient
• type ReqError
  • func (e *ReqError) Error() string
  • func (e *ReqError) Unwrap() error

Functions

func NewReqError

func NewReqError(req *http.Request, wrappedErr error) error

NewReqError builds ReqError

Types

type APIError

type APIError struct {
	ExpectedStatusCodes []int

	// Resp HTTP response
	Resp *http.Response

	// Err is either error body or error from io.Copy.
	// TODO: be more specific?
	Err error
}

APIError REST API error

func (*APIError) Error

func (e *APIError) Error() string

Error implements error interface

func (*APIError) Unwrap

func (e *APIError) Unwrap() error

Unwrap provides compatibility for Go 1.13+ error chains.

type Client

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

Client the REST API client

func NewClient

func NewClient(client *http.Client) *Client

NewClient returns REST API Client. Use https://github.com/cristalhq/hedgedhttp for retries. Check https://github.com/vtopc/restclient/tree/master/interceptors for middlewares/interceptors. TODO: switch to HTTPClient interface?

func (*Client) Do

func (c *Client) Do(req *http.Request, v interface{}, expectedStatusCodes ...int) error

Do executes HTTP request.

Stores the result in the value pointed to by v. If v is not a nil and not a pointer, Do returns a json.InvalidUnmarshalError. Use func `http.NewRequestWithContext` to create `req`.

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient a HTTP client

type ReqError

type ReqError struct {
	// Req HTTP request
	Req *http.Request

	// Err is either an (*APIError) or error from (*http.Client).Do()
	Err error
}

ReqError request error.

func (*ReqError) Error

func (e *ReqError) Error() string

Error implements error interface

func (*ReqError) Unwrap

func (e *ReqError) Unwrap() error

Unwrap provides compatibility for Go 1.13+ error chains.