v0.0.0-...-e5cb2a8 Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Sep 26, 2020 License: Apache-2.0 Imports: 21 Imported by: 0



httplib is an libs help you to curl remote url.

How to use?


you can use Get to crawl data.

import ""

str, err := httplib.Get("").String()
if err != nil {
    	// error


POST data to remote url

req := httplib.Post("")
str, err := req.String()
if err != nil {
    	// error

Set timeout

The default timeout is 60 seconds, function prototype:

SetTimeout(connectTimeout, readWriteTimeout time.Duration)


// GET
httplib.Get("").SetTimeout(100 * time.Second, 30 * time.Second)

httplib.Post("").SetTimeout(100 * time.Second, 30 * time.Second)


If you want to debug the request info, set the debug on


Set HTTP Basic Auth

str, err := Get("").SetBasicAuth("user", "passwd").String()
if err != nil {
    	// error


If request url is https, You can set the client support TSL:

httplib.SetTLSClientConfig(&tls.Config{InsecureSkipVerify: true})

More info about the tls.Config please visit

Set HTTP Version

some servers need to specify the protocol version of HTTP


some http request need setcookie. So set it like this:

cookie := &http.Cookie{}
cookie.Name = "username"
cookie.Value  = "astaxie"

Upload file

httplib support mutil file upload, use req.PostFile()

req := httplib.Post("")
req.PostFile("uploadfile1", "httplib.pdf")
str, err := req.String()
if err != nil {
    	// error

See godoc for further documentation and examples.



Package httplib is used as http.Client Usage:

import ""

	b := httplib.Post("")
	b.PostFile("uploadfile1", "httplib.pdf")
	b.PostFile("uploadfile2", "httplib.txt")
	str, err := b.String()
	if err != nil {

 more docs



This section is empty.


This section is empty.


func SetDefaultSetting

func SetDefaultSetting(setting BeegoHTTPSettings)

SetDefaultSetting overwrites default settings

func TimeoutDialer

func TimeoutDialer(cTimeout time.Duration, rwTimeout time.Duration) func(net, addr string) (c net.Conn, err error)

TimeoutDialer returns functions of connection dialer with timeout settings for http.Transport Dial field.


type BeegoHTTPRequest

type BeegoHTTPRequest struct {
	// contains filtered or unexported fields

BeegoHTTPRequest provides more useful methods than http.Request for requesting a url.

func Delete

func Delete(url string) *BeegoHTTPRequest

Delete returns *BeegoHttpRequest DELETE method.

func Get

func Get(url string) *BeegoHTTPRequest

Get returns *BeegoHttpRequest with GET method.

func Head(url string) *BeegoHTTPRequest

Head returns *BeegoHttpRequest with HEAD method.

func NewBeegoRequest

func NewBeegoRequest(rawurl, method string) *BeegoHTTPRequest

NewBeegoRequest returns *BeegoHttpRequest with specific method

func Post

func Post(url string) *BeegoHTTPRequest

Post returns *BeegoHttpRequest with POST method.

func Put

func Put(url string) *BeegoHTTPRequest

Put returns *BeegoHttpRequest with PUT method.

func (*BeegoHTTPRequest) AddFilters

func (b *BeegoHTTPRequest) AddFilters(fcs ...FilterChain) *BeegoHTTPRequest

AddFilters adds filter

func (*BeegoHTTPRequest) Body

func (b *BeegoHTTPRequest) Body(data interface{}) *BeegoHTTPRequest

Body adds request raw body. Supports string and []byte.

func (*BeegoHTTPRequest) Bytes

func (b *BeegoHTTPRequest) Bytes() ([]byte, error)

Bytes returns the body []byte in response. Calls Response inner.

func (*BeegoHTTPRequest) Debug

func (b *BeegoHTTPRequest) Debug(isdebug bool) *BeegoHTTPRequest

Debug sets show debug or not when executing request.

func (*BeegoHTTPRequest) DoRequest

func (b *BeegoHTTPRequest) DoRequest() (resp *http.Response, err error)

DoRequest executes client.Do

func (*BeegoHTTPRequest) DoRequestWithCtx

func (b *BeegoHTTPRequest) DoRequestWithCtx(ctx context.Context) (resp *http.Response, err error)

func (*BeegoHTTPRequest) DumpBody

func (b *BeegoHTTPRequest) DumpBody(isdump bool) *BeegoHTTPRequest

DumpBody sets the DumbBody field

func (*BeegoHTTPRequest) DumpRequest

func (b *BeegoHTTPRequest) DumpRequest() []byte

DumpRequest returns the DumpRequest

func (*BeegoHTTPRequest) GetRequest

func (b *BeegoHTTPRequest) GetRequest() *http.Request

GetRequest returns the request object

func (*BeegoHTTPRequest) Header

func (b *BeegoHTTPRequest) Header(key, value string) *BeegoHTTPRequest

Header adds header item string in request.

func (*BeegoHTTPRequest) JSONBody

func (b *BeegoHTTPRequest) JSONBody(obj interface{}) (*BeegoHTTPRequest, error)

JSONBody adds the request raw body encoded in JSON.

func (*BeegoHTTPRequest) Param

func (b *BeegoHTTPRequest) Param(key, value string) *BeegoHTTPRequest

Param adds query param in to request. params build query string as ?key1=value1&key2=value2...

func (*BeegoHTTPRequest) PostFile

func (b *BeegoHTTPRequest) PostFile(formname, filename string) *BeegoHTTPRequest

PostFile adds a post file to the request

func (*BeegoHTTPRequest) Response

func (b *BeegoHTTPRequest) Response() (*http.Response, error)

Response executes request client gets response manually.

func (*BeegoHTTPRequest) Retries

func (b *BeegoHTTPRequest) Retries(times int) *BeegoHTTPRequest

Retries sets Retries times. default is 0 (never retry) -1 retry indefinitely (forever) Other numbers specify the exact retry amount

func (*BeegoHTTPRequest) RetryDelay

func (b *BeegoHTTPRequest) RetryDelay(delay time.Duration) *BeegoHTTPRequest

RetryDelay sets the time to sleep between reconnection attempts

func (*BeegoHTTPRequest) SetBasicAuth

func (b *BeegoHTTPRequest) SetBasicAuth(username, password string) *BeegoHTTPRequest

SetBasicAuth sets the request's Authorization header to use HTTP Basic Authentication with the provided username and password.

func (*BeegoHTTPRequest) SetCheckRedirect

func (b *BeegoHTTPRequest) SetCheckRedirect(redirect func(req *http.Request, via []*http.Request) error) *BeegoHTTPRequest

SetCheckRedirect specifies the policy for handling redirects.

If CheckRedirect is nil, the Client uses its default policy, which is to stop after 10 consecutive requests.

func (*BeegoHTTPRequest) SetCookie

func (b *BeegoHTTPRequest) SetCookie(cookie *http.Cookie) *BeegoHTTPRequest

SetCookie adds a cookie to the request.

func (*BeegoHTTPRequest) SetEnableCookie

func (b *BeegoHTTPRequest) SetEnableCookie(enable bool) *BeegoHTTPRequest

SetEnableCookie sets enable/disable cookiejar

func (*BeegoHTTPRequest) SetFilters

func (b *BeegoHTTPRequest) SetFilters(fcs ...FilterChain) *BeegoHTTPRequest

SetFilters will use the filter as the invocation filters

func (*BeegoHTTPRequest) SetHost

func (b *BeegoHTTPRequest) SetHost(host string) *BeegoHTTPRequest

SetHost set the request host

func (*BeegoHTTPRequest) SetProtocolVersion

func (b *BeegoHTTPRequest) SetProtocolVersion(vers string) *BeegoHTTPRequest

SetProtocolVersion sets the protocol version for incoming requests. Client requests always use HTTP/1.1.

func (*BeegoHTTPRequest) SetProxy

func (b *BeegoHTTPRequest) SetProxy(proxy func(*http.Request) (*url.URL, error)) *BeegoHTTPRequest

SetProxy sets the HTTP proxy example:

func(req *http.Request) (*url.URL, error) {
	u, _ := url.ParseRequestURI("")
	return u, nil

func (*BeegoHTTPRequest) SetTLSClientConfig

func (b *BeegoHTTPRequest) SetTLSClientConfig(config *tls.Config) *BeegoHTTPRequest

SetTLSClientConfig sets TLS connection configuration if visiting HTTPS url.

func (*BeegoHTTPRequest) SetTimeout

func (b *BeegoHTTPRequest) SetTimeout(connectTimeout, readWriteTimeout time.Duration) *BeegoHTTPRequest

SetTimeout sets connect time out and read-write time out for BeegoRequest.

func (*BeegoHTTPRequest) SetTransport

func (b *BeegoHTTPRequest) SetTransport(transport http.RoundTripper) *BeegoHTTPRequest

SetTransport sets the transport field

func (*BeegoHTTPRequest) SetUserAgent

func (b *BeegoHTTPRequest) SetUserAgent(useragent string) *BeegoHTTPRequest

SetUserAgent sets User-Agent header field

func (*BeegoHTTPRequest) Setting

Setting changes request settings

func (*BeegoHTTPRequest) String

func (b *BeegoHTTPRequest) String() (string, error)

String returns the body string in response. Calls Response inner.

func (*BeegoHTTPRequest) ToFile

func (b *BeegoHTTPRequest) ToFile(filename string) error

ToFile saves the body data in response to one file. Calls Response inner.

func (*BeegoHTTPRequest) ToJSON

func (b *BeegoHTTPRequest) ToJSON(v interface{}) error

ToJSON returns the map that marshals from the body bytes as json in response. Calls Response inner.

func (*BeegoHTTPRequest) ToXML

func (b *BeegoHTTPRequest) ToXML(v interface{}) error

ToXML returns the map that marshals from the body bytes as xml in response . Calls Response inner.

func (*BeegoHTTPRequest) ToYAML

func (b *BeegoHTTPRequest) ToYAML(v interface{}) error

ToYAML returns the map that marshals from the body bytes as yaml in response . Calls Response inner.

func (*BeegoHTTPRequest) XMLBody

func (b *BeegoHTTPRequest) XMLBody(obj interface{}) (*BeegoHTTPRequest, error)

XMLBody adds the request raw body encoded in XML.

func (*BeegoHTTPRequest) YAMLBody

func (b *BeegoHTTPRequest) YAMLBody(obj interface{}) (*BeegoHTTPRequest, error)

YAMLBody adds the request raw body encoded in YAML.

type BeegoHTTPSettings

type BeegoHTTPSettings struct {
	ShowDebug        bool
	UserAgent        string
	ConnectTimeout   time.Duration
	ReadWriteTimeout time.Duration
	TLSClientConfig  *tls.Config
	Proxy            func(*http.Request) (*url.URL, error)
	Transport        http.RoundTripper
	CheckRedirect    func(req *http.Request, via []*http.Request) error
	EnableCookie     bool
	Gzip             bool
	DumpBody         bool
	Retries          int // if set to -1 means will retry forever
	RetryDelay       time.Duration
	FilterChains     []FilterChain

BeegoHTTPSettings is the http.Client setting

type Filter

type Filter func(ctx context.Context, req *BeegoHTTPRequest) (*http.Response, error)

type FilterChain

type FilterChain func(next Filter) Filter


Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL