Advanced HTTP client for golang.
- Chainable API
- Direct file upload
- Timeout
- HTTP Proxy
- Cookie
- GZIP
- Redirect Policy
- Cancel(with context)
go get github.com/ddliu/go-httpclientpackage main
import (
"github.com/ddliu/go-httpclient"
)
func main() {
httpclient.Defaults(httpclient.Map {
httpclient.OPT_USERAGENT: "my awsome httpclient",
"Accept-Language": "en-us",
})
res, err := httpclient.Get("http://google.com/search", map[string]string{
"q": "news",
})
println(res.StatusCode, err)
}Use httpclient.Defaults to setup default behaviors of the HTTP client.
httpclient.Defaults(httpclient.Map {
httpclient.OPT_USERAGENT: "my awsome httpclient",
"Accept-Language": "en-us",
})The OPT_XXX options define basic behaviours of this client, other values are
default request headers of this request. They are shared between different HTTP
requests.
// get
httpclient.Get("http://httpbin.org/get", map[string]string{
"q": "news",
})
// get with url.Values
httpclient.Get("http://httpbin.org/get", url.Values{
"q": []string{"news", "today"}
})
// post
httpclient.Post("http://httpbin.org/post", map[string]string {
"name": "value"
})
// post file(multipart)
httpclient.Post("http://httpbin.org/multipart", map[string]string {
"@file": "/tmp/hello.pdf",
})
// put json
httpclient.PutJson("http://httpbin.org/put",
`{
"name": "hello",
}`)
// delete
httpclient.Delete("http://httpbin.org/delete")
// options
httpclient.Options("http://httpbin.org")
// head
httpclient.Head("http://httpbin.org/get")Before you start a new HTTP request with Get or Post method, you can specify
temporary options, headers or cookies for current request.
httpclient.
WithHeader("User-Agent", "Super Robot").
WithHeader("custom-header", "value").
WithHeaders(map[string]string {
"another-header": "another-value",
"and-another-header": "another-value",
}).
WithOption(httpclient.OPT_TIMEOUT, 60).
WithCookie(&http.Cookie{
Name: "uid",
Value: "123",
}).
Get("http://github.com")The httpclient.Response is a thin wrap of http.Response.
// traditional
res, err := httpclient.Get("http://google.com")
bodyBytes, err := ioutil.ReadAll(res.Body)
res.Body.Close()
// ToString
res, err = httpclient.Get("http://google.com")
bodyString, err := res.ToString()
// ReadAll
res, err = httpclient.Get("http://google.com")
bodyBytes, err := res.ReadAll()url := "http://github.com"
httpclient.
WithCookie(&http.Cookie{
Name: "uid",
Value: "123",
}).
Get(url)
for _, cookie := range httpclient.Cookies() {
fmt.Println(cookie.Name, cookie.Value)
}
for k, v := range httpclient.CookieValues() {
fmt.Println(k, v)
}
fmt.Println(httpclient.CookieValue("uid"))If you want to start many requests concurrently, remember to call the Begin
method when you begin:
go func() {
httpclient.
Begin().
WithHeader("Req-A", "a").
Get("http://google.com")
}()
go func() {
httpclient.
Begin().
WithHeader("Req-B", "b").
Get("http://google.com")
}()You can use httpclient.IsTimeoutError to check for timeout error:
res, err := httpclient.Get("http://google.com")
if httpclient.IsTimeoutError(err) {
// do something
}See examples/main.go
Available options as below:
OPT_FOLLOWLOCATION: TRUE to follow any "Location: " header that the server sends as part of the HTTP header. Default totrue.OPT_CONNECTTIMEOUT: The number of seconds or interval (with time.Duration) to wait while trying to connect. Use 0 to wait indefinitely.OPT_CONNECTTIMEOUT_MS: The number of milliseconds to wait while trying to connect. Use 0 to wait indefinitely.OPT_MAXREDIRS: The maximum amount of HTTP redirections to follow. Use this option alongsideOPT_FOLLOWLOCATION.OPT_PROXYTYPE: Specify the proxy type. Valid options arePROXY_HTTP,PROXY_SOCKS4,PROXY_SOCKS5,PROXY_SOCKS4A. OnlyPROXY_HTTPis supported currently.OPT_TIMEOUT: The maximum number of seconds or interval (with time.Duration) to allow httpclient functions to execute.OPT_TIMEOUT_MS: The maximum number of milliseconds to allow httpclient functions to execute.OPT_COOKIEJAR: Set totrueto enable the default cookiejar, or you can set to ahttp.CookieJarinstance to use a customized jar. Default totrue.OPT_INTERFACE: TODOOPT_PROXY: Proxy host and port(127.0.0.1:1080).OPT_REFERER: TheRefererheader of the request.OPT_USERAGENT: TheUser-Agentheader of the request. Default to "go-httpclient v{{VERSION}}".OPT_REDIRECT_POLICY: Function to check redirect.OPT_PROXY_FUNC: Function to specify proxy.OPT_UNSAFE_TLS: Set totrueto disable TLS certificate checking.OPT_DEBUG: Print request info.OPT_CONTEXT: Setcontext.context(can be used to cancel request).OPT_BEFORE_REQUEST_FUNC: Function to call before request is sent, option should be typefunc(*http.Client, *http.Request).
By using the httpclient.Get, httpclient.Post methods etc, you are using a
default shared HTTP client.
If you need more than one client in a single programme. Just create and use them seperately.
c1 := httpclient.NewHttpClient().Defaults(httpclient.Map {
httpclient.OPT_USERAGENT: "browser1",
})
c1.Get("http://google.com/")
c2 := httpclient.NewHttpClient().Defaults(httpclient.Map {
httpclient.OPT_USERAGENT: "browser2",
})
c2.Get("http://google.com/")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent