requests

README

Requests

Go HTTP Client Library

Usage

// New Request
r := NewRequest(WithTimout(time.Second))

// New Session
r := NewSession(WithTimout(time.Second))

// do http method
r.Get(url, map[string]string{})
r.Post(url, map[string]interface{}{})
r.Post(url, map[string]interface{}{})
r.PostFrom(url, map[string]string{})
r.Put(url, map[string]interface{}{})
r.Delete(url, map[string]interface{}{})

// download
r.Download(filePath, originUrl)
r.DownloadWithRateLimit(filePath, originUrl, rate)

// upload
r.Upload(originUrl, map[string]string{}, filepath1, filepath2 ...)

// response
r.Content()
r.ContentToString()
r.Status() // status code, status
r.Resp() // raw http.Response

Documentation

Index

• Constants
• Variables
• func NewClient() *http.Client
• func NewTransport() *http.Transport
• func ProxyFromEnvironment(req *http.Request) (*url.URL, error)
• type Option
  • func WithBasicAuth(username, password string) Option
  • func WithBearerTokenAuth(token string) Option
  • func WithClient(client *http.Client) Option
  • func WithDefaultClient() Option
  • func WithDefaultTransport() Option
  • func WithHeader(headers ...map[string]string) Option
  • func WithProxyEnv(proxy Proxy) Option
  • func WithProxyFunc(f func(*http.Request) (*url.URL, error)) Option
  • func WithProxyUrl(proxy *url.URL) Option
  • func WithSkipTLS() Option
  • func WithTimeout(t time.Duration) Option
  • func WithTransport(tr http.RoundTripper) Option
  • func WithUnsetProxy() Option
• type Proxy
  • func NewHttpProxy(proxy string) Proxy
  • func NewHttpProxyWithAuth(proxy, username, password string) Proxy
  • func NewSocksProxy(proxy string) Proxy
  • func NewSocksProxyWithAuth(proxy, username, password string) Proxy
• type Request
  • func NewRequest(options ...Option) *Request
  • func NewSession(options ...Option) *Request
  • func (r Request) Content() []byte
  • func (r Request) ContentToString() string
  • func (r *Request) Delete(originUrl string, data map[string]interface{}) error
  • func (r *Request) Download(filePath, originUrl string) error
  • func (r *Request) DownloadWithRateLimit(filePath, originUrl string, rate int64) error
  • func (r *Request) Get(originUrl string, params map[string]string) error
  • func (r *Request) ParseUrl(originUrl string) error
  • func (r *Request) Post(originUrl string, data map[string]interface{}) error
  • func (r *Request) PostForm(originUrl string, data map[string]string) error
  • func (r *Request) Put(originUrl string, data map[string]interface{}) error
  • func (r Request) Request() *http.Request
  • func (r Request) Response() *http.Response
  • func (r *Request) SetBasicAuth(username, password string)
  • func (r *Request) SetBearerTokenAuth(token string)
  • func (r *Request) SetClient(client *http.Client)
  • func (r *Request) SetHeader(header map[string]string)
  • func (r *Request) SetProxyEnv(proxy Proxy)
  • func (r *Request) SetProxyFunc(f func(*http.Request) (*url.URL, error))
  • func (r *Request) SetProxyUrl(proxy *url.URL)
  • func (r *Request) SetSkipTLS()
  • func (r *Request) SetTimeout(t time.Duration)
  • func (r *Request) SetTransport(rt http.RoundTripper)
  • func (r Request) Status() (int, string)
  • func (r *Request) UnsetProxy()
  • func (r *Request) Upload(originUrl string, data map[string]string, filePaths ...string) error

Constants

const (
	ProxyHttp  = "http"
	ProxySocks = "socks5"
)

const (
	ContentTypeJson = "application/json;charset=utf-8"
	ContentTypeForm = "application/x-www-form-urlencoded"
)

Variables

var (
	DefaultTransport = NewTransport()
	DefaultClient    = NewClient()
)

Functions

func NewClient

func NewClient() *http.Client

func NewTransport

func NewTransport() *http.Transport

NewTransport is clone of http.DefaultTransport

func ProxyFromEnvironment

func ProxyFromEnvironment(req *http.Request) (*url.URL, error)

ProxyFromEnvironment read proxy form env for every request http.ProxyFromEnvironment read only once

Types

type Option

type Option func(*Request)

func WithBasicAuth

func WithBasicAuth(username, password string) Option

func WithBearerTokenAuth

func WithBearerTokenAuth(token string) Option

func WithClient

func WithClient(client *http.Client) Option

func WithDefaultClient

func WithDefaultClient() Option

func WithDefaultTransport

func WithDefaultTransport() Option

func WithHeader

func WithHeader(headers ...map[string]string) Option

func WithProxyEnv

func WithProxyEnv(proxy Proxy) Option

func WithProxyFunc

func WithProxyFunc(f func(*http.Request) (*url.URL, error)) Option

func WithProxyUrl

func WithProxyUrl(proxy *url.URL) Option

func WithSkipTLS

func WithSkipTLS() Option

func WithTimeout

func WithTimeout(t time.Duration) Option

func WithTransport

func WithTransport(tr http.RoundTripper) Option

func WithUnsetProxy

func WithUnsetProxy() Option

type Proxy

type Proxy map[string]string

func NewHttpProxy

func NewHttpProxy(proxy string) Proxy

func NewHttpProxyWithAuth

func NewHttpProxyWithAuth(proxy, username, password string) Proxy

func NewSocksProxy

func NewSocksProxy(proxy string) Proxy

func NewSocksProxyWithAuth

func NewSocksProxyWithAuth(proxy, username, password string) Proxy

type Request

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

func NewRequest

func NewRequest(options ...Option) *Request

func NewSession

func NewSession(options ...Option) *Request

func (Request) Content

func (r Request) Content() []byte

func (Request) ContentToString

func (r Request) ContentToString() string

func (*Request) Delete

func (r *Request) Delete(originUrl string, data map[string]interface{}) error

func (*Request) Download

func (r *Request) Download(filePath, originUrl string) error

func (*Request) DownloadWithRateLimit

func (r *Request) DownloadWithRateLimit(filePath, originUrl string, rate int64) error

func (*Request) Get

func (r *Request) Get(originUrl string, params map[string]string) error

func (*Request) ParseUrl

func (r *Request) ParseUrl(originUrl string) error

func (*Request) Post

func (r *Request) Post(originUrl string, data map[string]interface{}) error

func (*Request) PostForm

func (r *Request) PostForm(originUrl string, data map[string]string) error

func (*Request) Put

func (r *Request) Put(originUrl string, data map[string]interface{}) error

func (Request) Request

func (r Request) Request() *http.Request

func (Request) Response

func (r Request) Response() *http.Response

func (*Request) SetBasicAuth

func (r *Request) SetBasicAuth(username, password string)

func (*Request) SetBearerTokenAuth

func (r *Request) SetBearerTokenAuth(token string)

func (*Request) SetClient

func (r *Request) SetClient(client *http.Client)

func (*Request) SetHeader

func (r *Request) SetHeader(header map[string]string)

func (*Request) SetProxyEnv

func (r *Request) SetProxyEnv(proxy Proxy)

func (*Request) SetProxyFunc

func (r *Request) SetProxyFunc(f func(*http.Request) (*url.URL, error))

func (*Request) SetProxyUrl

func (r *Request) SetProxyUrl(proxy *url.URL)

func (*Request) SetSkipTLS

func (r *Request) SetSkipTLS()

func (*Request) SetTimeout

func (r *Request) SetTimeout(t time.Duration)

func (*Request) SetTransport

func (r *Request) SetTransport(rt http.RoundTripper)

func (Request) Status

func (r Request) Status() (int, string)

func (*Request) UnsetProxy

func (r *Request) UnsetProxy()

func (*Request) Upload

func (r *Request) Upload(originUrl string, data map[string]string, filePaths ...string) error