resty

Documentation

Overview

Package resty HTTP and REST client library with parallel feature

Index

• Variables
• type Client
• type Handle
• type Option
  • func WithClient(c Client) Option
  • func WithHeader(header map[string]string) Option
  • func WithRequestInterceptor(interceptor func(req *http.Request) error) Option
  • func WithRetry(retry int) Option
  • func WithTransport(transport *http.Transport) Option
• type Resty
  • func New(opts ...Option) *Resty
  • func (r *Resty) Do(ctx context.Context, method string, body io.Reader, urls ...string) *Resty
  • func (r *Resty) DoDelete(ctx context.Context, urls ...string) *Resty
  • func (r *Resty) DoGet(ctx context.Context, urls ...string) *Resty
  • func (r *Resty) DoPost(ctx context.Context, body io.Reader, urls ...string) *Resty
  • func (r *Resty) DoPut(ctx context.Context, body io.Reader, urls ...string) *Resty
  • func (r *Resty) First() []error
  • func (r *Resty) Then(fn Handle) *Resty
  • func (r *Resty) Wait() []error
• type Result

Variables

var (
	// DefaultDialTimeout default timeout of a dialer
	DefaultDialTimeout = 5 * time.Second
	// DefaultRequestTimeout default time out of a http request
	DefaultRequestTimeout = 10 * time.Second
	// DefaultRetry retry times if a request is failed with 5xx status code
	DefaultRetry = 3
)

var CreateClient = func(t *http.Transport, timeout time.Duration) Client {
	client := &http.Client{
		Transport: t,
	}
	if timeout > 0 {
		client.Timeout = timeout
	}

	return client
}

CreateClient a function that create a client instance

var DefaultHeader = make(map[string]string)

var DefaultTransport = &http.Transport{
	Proxy:                 http.ProxyFromEnvironment,
	MaxIdleConns:          1000,
	IdleConnTimeout:       90 * time.Second,
	TLSHandshakeTimeout:   10 * time.Second,
	ExpectContinueTimeout: 1 * time.Second,
	MaxIdleConnsPerHost:   5,
	ForceAttemptHTTP2:     true,

	DialContext: (&net.Dialer{
		Timeout:   30 * time.Second,
		KeepAlive: 30 * time.Second,
		DualStack: true,
	}).DialContext,
}

Run the HTTP request in a goroutine and pass the response to f.

Types

type Client

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

Client http client

type Handle

type Handle func(req *http.Request, resp *http.Response, respBody []byte, cf context.CancelFunc, err error) error

Handle handler of http response

type Option

type Option func(*Resty)

Option set restry option

func WithClient

func WithClient(c Client) Option

WithClient set client

func WithHeader

func WithHeader(header map[string]string) Option

WithHeader set header for http request

func WithRequestInterceptor

func WithRequestInterceptor(interceptor func(req *http.Request) error) Option

WithRequestInterceptor intercept request

func WithRetry

func WithRetry(retry int) Option

WithRetry set retry times if request is failure with 5xx status code. retry is ingore if it is less than 1.

func WithTransport

func WithTransport(transport *http.Transport) Option

WithTransport set transport

type Resty

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

Resty HTTP and REST client library with parallel feature

func New

func New(opts ...Option) *Resty

New create a Resty instance.

func (*Resty) Do

func (r *Resty) Do(ctx context.Context, method string, body io.Reader, urls ...string) *Resty

func (*Resty) DoDelete

func (r *Resty) DoDelete(ctx context.Context, urls ...string) *Resty

DoDelete executes http requests with DELETE method in parallel

func (*Resty) DoGet

func (r *Resty) DoGet(ctx context.Context, urls ...string) *Resty

DoGet executes http requests with GET method in parallel

func (*Resty) DoPost

func (r *Resty) DoPost(ctx context.Context, body io.Reader, urls ...string) *Resty

DoPost executes http requests with POST method in parallel

func (*Resty) DoPut

func (r *Resty) DoPut(ctx context.Context, body io.Reader, urls ...string) *Resty

DoPut executes http requests with PUT method in parallel

func (*Resty) First

func (r *Resty) First() []error

First successful result or errors

func (*Resty) Then

func (r *Resty) Then(fn Handle) *Resty

Then is used to call the handle function when the request has completed processing

func (*Resty) Wait

func (r *Resty) Wait() []error

Wait waits for all the requests to be completed

type Result

type Result struct {
	Request      *http.Request
	Response     *http.Response
	ResponseBody []byte
	Err          error
}

Result result of a http request