httplib

Documentation

Index

• func SetDefaultSetting(setting BeegoHttpSettings)
• func TimeoutDialer(cTimeout time.Duration, rwTimeout time.Duration) func(ctx context.Context, net, addr string) (c net.Conn, err error)
• type BeegoHttpRequest
  • func Delete(url string) *BeegoHttpRequest
  • func Get(url string) *BeegoHttpRequest
  • func Head(url string) *BeegoHttpRequest
  • func NewBeegoRequest(rawURL, method string) *BeegoHttpRequest
  • func Post(url string) *BeegoHttpRequest
  • func Put(url string) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) Body(data interface{}) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) Bytes() ([]byte, error)
  • func (b *BeegoHttpRequest) Debug(debug bool) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) DumpBody(dump bool) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) DumpRequest() []byte
  • func (b *BeegoHttpRequest) GetRequest() *http.Request
  • func (b *BeegoHttpRequest) Header(key, value string) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) JsonBody(obj interface{}) (*BeegoHttpRequest, error)
  • func (b *BeegoHttpRequest) Param(key, value string) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) PostFile(formname, filename string) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) Response() (*http.Response, error)
  • func (b *BeegoHttpRequest) SendOut() (*http.Response, error)
  • func (b *BeegoHttpRequest) SetBasicAuth(username, password string) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) SetCookie(cookie *http.Cookie) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) SetEnableCookie(enable bool) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) SetHost(host string) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) SetProtocolVersion(version string) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) SetProxy(proxy *url.URL) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) SetTLSClientConfig(config *tls.Config) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) SetTimeout(connectTimeout, readWriteTimeout time.Duration) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) SetTransport(transport http.RoundTripper) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) SetUserAgent(value string) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) Setting(setting BeegoHttpSettings) *BeegoHttpRequest
  • func (b *BeegoHttpRequest) String() (string, error)
  • func (b *BeegoHttpRequest) ToFile(filename string) error
  • func (b *BeegoHttpRequest) ToJSON(v interface{}) error
  • func (b *BeegoHttpRequest) ToXML(v interface{}) error
• type BeegoHttpSettings

Functions

func SetDefaultSetting

func SetDefaultSetting(setting BeegoHttpSettings)

SetDefaultSetting is used to overwrite default settings.

func TimeoutDialer

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

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

Types

type BeegoHttpRequest

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

BeegoHttpRequest provides more useful methods for requesting one url than http.Request.

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

func Head(url string) *BeegoHttpRequest

Head returns *BeegoHttpRequest with HEAD method.

func NewBeegoRequest

func NewBeegoRequest(rawURL, method string) *BeegoHttpRequest

NewBeegoRequest will return *BeegoHttpRequest with the specified 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) Body

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

Body adds request raw body. it supports string and []byte.

func (*BeegoHttpRequest) Bytes

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

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

func (*BeegoHttpRequest) Debug

func (b *BeegoHttpRequest) Debug(debug bool) *BeegoHttpRequest

Debug sets show debug or not when executing request.

func (*BeegoHttpRequest) DumpBody

func (b *BeegoHttpRequest) DumpBody(dump bool) *BeegoHttpRequest

DumpBody will dump the body.

func (*BeegoHttpRequest) DumpRequest

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

DumpRequest will dump the request.

func (*BeegoHttpRequest) GetRequest

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

GetRequest returns the http.Request.

func (*BeegoHttpRequest) Header

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

Header add header item string in request.

func (*BeegoHttpRequest) JsonBody

func (b *BeegoHttpRequest) JsonBody(obj interface{}) (*BeegoHttpRequest, error)

JsonBody adds request raw body encoding by 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

func (*BeegoHttpRequest) Response

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

Response executes request client gets response manually.

func (*BeegoHttpRequest) SendOut

func (b *BeegoHttpRequest) SendOut() (*http.Response, error)

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) SetCookie

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

SetCookie add cookie into request.

func (*BeegoHttpRequest) SetEnableCookie

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

SetEnableCookie sets enable/disable cookiejar

func (*BeegoHttpRequest) SetHost

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

SetHost will set the HOST header.

func (*BeegoHttpRequest) SetProtocolVersion

func (b *BeegoHttpRequest) SetProtocolVersion(version string) *BeegoHttpRequest

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

func (*BeegoHttpRequest) SetProxy

func (b *BeegoHttpRequest) SetProxy(proxy *url.URL) *BeegoHttpRequest

func (*BeegoHttpRequest) SetTLSClientConfig

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

SetTLSClientConfig sets tls connection configurations 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 beego transport.

func (*BeegoHttpRequest) SetUserAgent

func (b *BeegoHttpRequest) SetUserAgent(value string) *BeegoHttpRequest

SetUserAgent sets User-Agent header field

func (*BeegoHttpRequest) Setting

func (b *BeegoHttpRequest) Setting(setting BeegoHttpSettings) *BeegoHttpRequest

Setting changes the request settings.

func (*BeegoHttpRequest) String

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

String returns the body string in response. it calls Response inner.

func (*BeegoHttpRequest) ToFile

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

ToFile saves the body data in response to one file. it 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 . it 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 . it calls Response inner.

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
	EnableCookie     bool
	Gzip             bool
	DumpBody         bool
}

BeegoHttpSettings contain client settings.