grequests

grequests

A simple and user-friendly HTTP request library for Go, inspired by the well-known Python project requests.

Features

• GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, etc.
• Easy set query params, headers and cookies.
• Easy send form, JSON or files payload.
• Easy set basic authentication or bearer token.
• Easy customize root certificate authorities and client certificates.
• Easy set proxy.
• Automatic cookie management.
• Customize HTTP client, transport, redirect policy, cookie jar and timeout.
• Easy set context.
• Easy serialize responses into JSON.
• Concurrent safe.

Install

go get -u github.com/winterssy/grequests

Usage

import "github.com/winterssy/grequests"

Examples

• Set Params
• Set Headers
• Set Cookies
• Set Form Payload
• Set JSON Payload
• Set Files Payload
• Set Basic Authentication
• Set Bearer Token
• Customize HTTP Client
• Set Proxy
• Concurrent Safe

Set Params

data, err := grequests.
    Get("http://httpbin.org/get").
    Params(grequests.Value{
        "key1": "value1",
        "key2": "value2",
    }).
    Send().
    Text()
if err != nil {
    panic(err)
}
fmt.Println(data)

Set Headers

data, err := grequests.
    Get("http://httpbin.org/get").
    Headers(grequests.Value{
        "Origin":  "http://httpbin.org",
        "Referer": "http://httpbin.org",
    }).
    Send().
    Text()
if err != nil {
    panic(err)
}
fmt.Println(data)

Set Cookies

data, err := grequests.
    Get("http://httpbin.org/cookies/set").
    Cookies(
        &http.Cookie{
            Name:  "name1",
            Value: "value1",
        },
        &http.Cookie{
            Name:  "name2",
            Value: "value2",
        },
    ).
    Send().
    Text()
if err != nil {
    panic(err)
}
fmt.Println(data)

Set Form Payload

data, err := grequests.
    Post("http://httpbin.org/post").
    Form(grequests.Value{
        "key1": "value1",
        "key2": "value2",
    }).
    Send().
    Text()
if err != nil {
    panic(err)
}
fmt.Println(data)

Set JSON Payload

data, err := grequests.
    Post("http://httpbin.org/post").
    JSON(grequests.Data{
        "msg": "hello world",
        "num": 2019,
    }).
    Send().
    Text()
if err != nil {
    panic(err)
}
fmt.Println(data)

Set Files Payload

data, err := grequests.
    Post("http://httpbin.org/post").
    Files(
        &grequests.File{
            FieldName: "testimage1",
            FileName:  "testimage1.jpg",
            FilePath:  "./testdata/testimage1.jpg",
        },
        &grequests.File{
            FieldName: "testimage2",
            FileName:  "testimage2.jpg",
            FilePath:  "./testdata/testimage2.jpg",
        },
    ).
    Send().
    Text()
if err != nil {
    panic(err)
}
fmt.Println(data)

Set Basic Authentication

data, err := grequests.
    Get("http://httpbin.org/basic-auth/admin/pass").
    BasicAuth("admin", "pass").
    Send().
    Text()
if err != nil {
    panic(err)
}
fmt.Println(data)

Set Bearer Token

data, err := grequests.
    Get("http://httpbin.org/bearer").
    BearerToken("grequests").
    Send().
    Text()
if err != nil {
    panic(err)
}
fmt.Println(data)

Customize HTTP Client

transport := &http.Transport{
    Proxy: http.ProxyFromEnvironment,
    DialContext: (&net.Dialer{
        Timeout:   30 * time.Second,
        KeepAlive: 30 * time.Second,
    }).DialContext,
    MaxIdleConns:          100,
    IdleConnTimeout:       90 * time.Second,
    TLSHandshakeTimeout:   10 * time.Second,
    ExpectContinueTimeout: 1 * time.Second,
}
redirectPolicy := func(req *http.Request, via []*http.Request) error {
    return http.ErrUseLastResponse
}
jar, _ := cookiejar.New(&cookiejar.Options{
    PublicSuffixList: publicsuffix.List,
})
timeout := 120 * time.Second

req := grequests.
    WithTransport(transport).
    WithRedirectPolicy(redirectPolicy).
    WithCookieJar(jar).
    WithTimeout(timeout)

data, err := req.
    Get("http://httpbin.org/get").
    Send().
    Text()
if err != nil {
    panic(err)
}
fmt.Println(data)

Set Proxy

data, err := grequests.
    WithProxy("http://127.0.0.1:1081").
    Get("http://httpbin.org/get").
    Send().
    Text()
if err != nil {
    panic(err)
}
fmt.Println(data)

Concurrent Safe

const MaxWorker = 1000
wg := new(sync.WaitGroup)

for i := 0; i < MaxWorker; i += 1 {
    wg.Add(1)
    go func(i int) {
        defer wg.Done()

        params := grequests.Value{}
        params.Set(fmt.Sprintf("key%d", i), fmt.Sprintf("value%d", i))

        data, err := grequests.
            AcquireLock().
            Get("http://httpbin.org/get").
            Params(params).
            Send().
            Text()
        if err != nil {
            return
        }

        fmt.Println(data)
    }(i)
}

wg.Wait()

License

MIT.

Thanks

• xuanbo/requests
• ddliu/go-httpclient
• go-resty/resty