fetch

README

Fetch - HTTP Client

Installation

To install the package, run:

go get github.com/go-zoox/fetch

Getting Started

response, _ := fetch.Get("https://httpbin.zcorky.com/get")
url := response.Get("url")
method := response.Get("method")

fmt.Println(url, method)

Depencencies

• gjson - Get JSON Whenever You Need, you don't define type first。
• mozillazg/request - A developer-friendly HTTP request library for Gopher

License

GoZoox is released under the MIT License.

Documentation

Index

• Variables
• func DefaultUserAgent() string
• func SetBaseURL(url string)
• func SetTimeout(timeout time.Duration)
• func SetUserAgent(userAgent string)
• type Config
  • func DefaultConfig() *Config
  • func (cfg *Config) Merge(config *Config)
• type ConfigBody
• type ConfigHeaders
  • func (h ConfigHeaders) Get(key string) string
• type ConfigParams
  • func (h ConfigParams) Get(key string) string
• type ConfigQuery
  • func (h ConfigQuery) Get(key string) string
• type DataSource
• type Fetch
  • func New(cfg ...*Config) *Fetch
  • func (f *Fetch) Clone() *Fetch
  • func (f *Fetch) Delete(url string, config ...*Config) *Fetch
  • func (f *Fetch) Download(url string, filepath string, config ...*Config) *Fetch
  • func (f *Fetch) Execute() (*Response, error)
  • func (f *Fetch) Get(url string, config ...*Config) *Fetch
  • func (f *Fetch) Head(url string, config ...*Config) *Fetch
  • func (f *Fetch) Patch(url string, config ...*Config) *Fetch
  • func (f *Fetch) Post(url string, config ...*Config) *Fetch
  • func (f *Fetch) Put(url string, config ...*Config) *Fetch
  • func (f *Fetch) Send() (*Response, error)
  • func (f *Fetch) SetAuthorization(token string) *Fetch
  • func (f *Fetch) SetBaseURL(url string) *Fetch
  • func (f *Fetch) SetBasicAuth(username, password string) *Fetch
  • func (f *Fetch) SetBearToken(token string) *Fetch
  • func (f *Fetch) SetBody(body ConfigBody) *Fetch
  • func (f *Fetch) SetConfig(configs ...*Config) *Fetch
  • func (f *Fetch) SetDownloadFilePath(filepath string) *Fetch
  • func (f *Fetch) SetHeader(key, value string) *Fetch
  • func (f *Fetch) SetMethod(method string) *Fetch
  • func (f *Fetch) SetParam(key, value string) *Fetch
  • func (f *Fetch) SetProxy(proxy string) *Fetch
  • func (f *Fetch) SetQuery(key, value string) *Fetch
  • func (f *Fetch) SetTimeout(timeout time.Duration) *Fetch
  • func (f *Fetch) SetUrl(url string) *Fetch
  • func (f *Fetch) SetUserAgent(userAgent string) *Fetch
• type Response
  • func Delete(url string, config *Config) (*Response, error)
  • func Download(url string, filepath string, config ...interface{}) (*Response, error)
  • func Get(url string, config ...interface{}) (*Response, error)
  • func Head(url string, config ...interface{}) (*Response, error)
  • func Patch(url string, config *Config) (*Response, error)
  • func Post(url string, config *Config) (*Response, error)
  • func Put(url string, config *Config) (*Response, error)
  • func (r *Response) Get(key string) gjson.Result
  • func (r *Response) JSON() (string, error)
  • func (r *Response) String() string
  • func (r *Response) UnmarshalJSON(v interface{}) error
  • func (r *Response) UnmarshalYAML(v interface{}) error
  • func (r *Response) Value() gjson.Result

Variables

var BaseURL = ""

var DELETE = "DELETE"

var ErrCannotCopyFile = errors.New("cannot copy file")

var ErrCannotCreateFormFile = errors.New("cannot create form file")

var ErrCannotCreateRequest = errors.New("cannot create request")

var ErrCannotSendBodyWithGet = errors.New("cannot send body with GET method")

var ErrInvalidBodyMultipart = errors.New("invalid body multipart")

var ErrInvalidContentType = errors.New("invalid content type")

var ErrInvalidJSONBody = errors.New("error marshalling body")

var ErrInvalidMethod = errors.New("invalid method")

var ErrInvalidUrlFormEncodedBody = errors.New("invalid url form encoded body")

var ErrReadingResponse = errors.New("error reading response")

var ErrSendingRequest = errors.New("error sending request")

var ErrTooManyArguments = errors.New("too many arguments")

var ErrorInvalidBody = errors.New("invalid body")

var GET = "GET"

var HEAD = "HEAD"

var METHODS = []string{
	HEAD,
	GET,
	POST,
	PUT,
	DELETE,
	PATCH,
}

var PATCH = "PATCH"

var POST = "POST"

var PUT = "PUT"

var Timeout = 60 * time.Second

var UserAgent = fmt.Sprintf("GoFetch/%s (github.com/go-zoox/fetch)", Version)

var Version = "1.2.0"

Functions

func DefaultUserAgent

func DefaultUserAgent() string

func SetBaseURL

func SetBaseURL(url string)

func SetTimeout

func SetTimeout(timeout time.Duration)

func SetUserAgent

func SetUserAgent(userAgent string)

Types

type Config

type Config struct {
	Url     string
	Method  string
	Headers ConfigHeaders
	Query   ConfigQuery
	Params  ConfigParams
	Body    ConfigBody
	//
	BaseURL string
	Timeout time.Duration
	//
	DownloadFilePath string
	//
	Proxy string
}

func DefaultConfig

func DefaultConfig() *Config

func (*Config) Merge

func (cfg *Config) Merge(config *Config)

type ConfigBody

type ConfigBody interface{}

type ConfigHeaders

type ConfigHeaders map[string]string

func (ConfigHeaders) Get

func (h ConfigHeaders) Get(key string) string

type ConfigParams

type ConfigParams map[string]string

func (ConfigParams) Get

func (h ConfigParams) Get(key string) string

type ConfigQuery

type ConfigQuery map[string]string

func (ConfigQuery) Get

func (h ConfigQuery) Get(key string) string

type DataSource

type DataSource interface {
	Get(key string) string
}

DataSource defines the interface for loading data from a data source.

type Fetch

type Fetch struct {
	Errors []error
	// contains filtered or unexported fields
}

func New

func New(cfg ...*Config) *Fetch

func (*Fetch) Clone

func (f *Fetch) Clone() *Fetch

func (*Fetch) Delete

func (f *Fetch) Delete(url string, config ...*Config) *Fetch

func (*Fetch) Download

func (f *Fetch) Download(url string, filepath string, config ...*Config) *Fetch

func (*Fetch) Execute

func (f *Fetch) Execute() (*Response, error)

func (*Fetch) Get

func (f *Fetch) Get(url string, config ...*Config) *Fetch

func (*Fetch) Head

func (f *Fetch) Head(url string, config ...*Config) *Fetch

func (*Fetch) Patch

func (f *Fetch) Patch(url string, config ...*Config) *Fetch

func (*Fetch) Post

func (f *Fetch) Post(url string, config ...*Config) *Fetch

func (*Fetch) Put

func (f *Fetch) Put(url string, config ...*Config) *Fetch

func (*Fetch) Send

func (f *Fetch) Send() (*Response, error)

func (*Fetch) SetAuthorization

func (f *Fetch) SetAuthorization(token string) *Fetch

func (*Fetch) SetBaseURL

func (f *Fetch) SetBaseURL(url string) *Fetch

func (*Fetch) SetBasicAuth

func (f *Fetch) SetBasicAuth(username, password string) *Fetch

func (*Fetch) SetBearToken

func (f *Fetch) SetBearToken(token string) *Fetch

func (*Fetch) SetBody

func (f *Fetch) SetBody(body ConfigBody) *Fetch

func (*Fetch) SetConfig

func (f *Fetch) SetConfig(configs ...*Config) *Fetch

func (*Fetch) SetDownloadFilePath

func (f *Fetch) SetDownloadFilePath(filepath string) *Fetch

func (*Fetch) SetHeader

func (f *Fetch) SetHeader(key, value string) *Fetch

func (*Fetch) SetMethod

func (f *Fetch) SetMethod(method string) *Fetch

func (*Fetch) SetParam

func (f *Fetch) SetParam(key, value string) *Fetch

func (*Fetch) SetProxy

func (f *Fetch) SetProxy(proxy string) *Fetch

SetProxy sets the proxy

	support http, https, socks5
 example:
		http://127.0.0.1:17890
	  https://127.0.0.1:17890
	  socks5://127.0.0.1:17890

func (*Fetch) SetQuery

func (f *Fetch) SetQuery(key, value string) *Fetch

func (*Fetch) SetTimeout

func (f *Fetch) SetTimeout(timeout time.Duration) *Fetch

func (*Fetch) SetUrl

func (f *Fetch) SetUrl(url string) *Fetch

func (*Fetch) SetUserAgent

func (f *Fetch) SetUserAgent(userAgent string) *Fetch

type Response

type Response struct {
	Status  int
	Headers http.Header
	Body    []byte
	// contains filtered or unexported fields
}

func Delete

func Delete(url string, config *Config) (*Response, error)

func Download

func Download(url string, filepath string, config ...interface{}) (*Response, error)

func Get

func Get(url string, config ...interface{}) (*Response, error)

func Head

func Head(url string, config ...interface{}) (*Response, error)

func Patch

func Patch(url string, config *Config) (*Response, error)

func Post

func Post(url string, config *Config) (*Response, error)

func Put

func Put(url string, config *Config) (*Response, error)

func (*Response) Get

func (r *Response) Get(key string) gjson.Result

func (*Response) JSON

func (r *Response) JSON() (string, error)

func (*Response) String

func (r *Response) String() string

func (*Response) UnmarshalJSON

func (r *Response) UnmarshalJSON(v interface{}) error

func (*Response) UnmarshalYAML

func (r *Response) UnmarshalYAML(v interface{}) error

func (*Response) Value

func (r *Response) Value() gjson.Result