Requests

Requests is an HTTP library like python requests.

• Requests
• Installation
• Examples
  • Get
  • Post
    • Debug Mode
    • Post params
      • Post application/x-www-form-urlencoded
    • Post multipart/form-data
    • Post Json: application/json
    • Post Raw text/plain
    • PostFiles
  • Session Support
  • Request Options
    • SetTimeout
    • Set Authentication
    • Set Cookie
    • Set header
  • Response
    • Fetch Response Body
    • Fetch Response Cookies
    • Response examples
• Utils
  • Build Request
  • Generate curl shell command
  • Retry request
• Feature Support
• Thanks

Installation

go get -u github.com/ahuigo/requests

Examples

For more examples, refer to examples/post and all examples

Get

package main
import (
    "github.com/ahuigo/requests"
    "fmt"
)

func main(){
    var json map[string]interface{}
    params := requests.Params{"name": "ahuigo", "page":"1"}
    resp, err := requests.Get("https://httpbin.org/json", params)
    if err != nil {
        panic(err)
    }else{
        resp.Json(&json)
        for k, v := range json {
            fmt.Println(k, v)
        }
    }
}

Post

Debug Mode

Refer to https://github.com/ahuigo/requests/blob/master/examples/debug_test.go

session := requests.R()
resp, err := session.SetDebug().Post(
	"https://www.httpbin.org/post",
	requests.Files{
        "file1": "/README.md",
        "file2": "/version",
    },
)
/* Output:
 curl -X POST -F 'file1=@/README.md' -F 'file2=@/version' https://www.httpbin.org/post
 .....
 */

Post params

// Post params
func TestPostParams(t *testing.T) {
    println("Test POST: post params")
    data := requests.Params{
        "name": "ahuigo",
    }
    resp, err := requests.Post("https://www.httpbin.org/post", data)
    if err == nil {
        fmt.Println(resp.Text())
    }
}

Post application/x-www-form-urlencoded

// Post Form UrlEncoded data: application/x-www-form-urlencoded
func TestPostFormUrlEncode(t *testing.T) {
    resp, err := requests.Post(
        "https://www.httpbin.org/post",
        requests.Datas{
            "name": "ahuigo",
        },
    )
    if err != nil {
        t.Error(err)
    }
    var data = struct {
        Form struct {
            Name string
        }
    }{}
    resp.Json(&data)
    if data.Form.Name != "ahuigo" {
        t.Error("invalid response body:", resp.Text())
    }
}

Post multipart/form-data

// Test POST:  multipart/form-data; boundary=....
func TestPostFormData(t *testing.T) {
    resp, err := requests.Post(
        "https://www.httpbin.org/post",
        requests.FormData{
            "name": "ahuigo",
        },
    )
    if err != nil {
        t.Error(err)
    }
    var data = struct {
        Form struct {
            Name string
        }
    }{}
    resp.Json(&data)
    if data.Form.Name != "ahuigo" {
        t.Error("invalid response body:", resp.Text())
    }
}

Post Json: application/json

func TestPostJson(t *testing.T) {
	// You can also use `json := requests.Jsoni(anyTypeData)`
    json := requests.Json{
        "key": "value",
    }
    resp, err := requests.Post("https://www.httpbin.org/post", json)
    if err == nil {
        fmt.Println(resp.Text())
    }
}

Post Raw text/plain

func TestRawString(t *testing.T) {
    println("Test POST: post data and json")
    rawText := "raw data: Hi, Jack!"
    resp, err := requests.Post(
        "https://www.httpbin.org/post", 
        rawText,
        requests.Header{"Content-Type": "text/plain"},
    )
    if err == nil {
        fmt.Println(resp.Text())
    }
}

PostFiles

An example about post both file and form data:

// curl "https://www.httpbin.org/post" -F 'file1=@./go.mod' -F 'file2=@./version' -F 'name=alex'
path, _ := os.Getwd()
session := requests.R()

resp, err := session.SetDebug().Post(
	"https://www.httpbin.org/post",
	requests.Files{
        "file1": path + "/go.mod",
        "file2": path + "/version",
    },
    requests.FormData{
		"name": "alex",
	},
)
if err == nil {
	fmt.Println(resp.Text())
}

Session Support

// 0. Make a session
session := r.R()

// 1. First, set cookies: count=100
var data struct {
	Cookies struct {
		Count string `json:"count"`
	}
}
session.Get("https://httpbin.org/cookies/set?count=100")

// 2. Second, get cookies
resp, err := session.Get("https://httpbin.org/cookies")
if err == nil {
	resp.Json(&data)
    if data.Cookies.Count!="100"{
        t.Fatal("Failed to get valid cookies: "+resp.Text())
    }
}

Warning: Session is not safe in multi goroutines. You can not do as following:

// Bad! Do not call session in in multi goroutine!!!!!
session := requests.R()

// goroutine 1
go func(){
   session.Post(url1) 
}()

// goroutine 2
go func(){
   session.Post(url2) 
}()

Request Options

SetTimeout

session := Requests.R()
session.SetTimeout(20*time.Second)

Set Authentication

session := requests.R()
resp,_ := session.Get("https://api.github.com/user",requests.Auth{"asmcos","password...."})

Set Cookie

cookie1 := http.Cookie{Name: "cookie_name", Value: "cookie_value"}
session.SetCookie(&cookie1)

Set header

func TestGetParamsHeaders(t *testing.T) {
    println("Test Get: custom header and params")
    requests.Get("http://www.zhanluejia.net.cn",
        requests.Header{"Referer": "http://www.jeapedu.com"},
        requests.Params{"page": "1", "size": "20"},
        requests.Params{"name": "ahuio"},
    )
}

func TestGetParamsHeaders2(t *testing.T) {
    session := requests.R()
    session.SetHeader("accept-encoding", "gzip, deflate, br")
    session.Run("http://www.zhanluejia.net.cn",
        requests.Params{"page": "1", "size": "20"},
        requests.Params{"name": "ahuio"},
    )
}

func TestResponseHeader(t *testing.T) {
    resp, _ := requests.Get("https://www.baidu.com/")
    println(resp.Text())
    println(resp.R.Header.Get("location"))
    println(resp.R.Header.Get("Location"))
}

two or more headers ...

headers1 := requests.Header{"Referer": "http://www.jeapedu.com"},
....
resp,_ = session.Get(
    "http://www.zhanluejia.net.cn",
    headers1,
    headers2,
    headers3,
)

Response

Fetch Response Body

https://github.com/ahuigo/requests/blob/master/examples/resp_test.go

fmt.Println(resp.Text())    // string
fmt.Println(resp.Body())    //[]byte

Fetch Response Cookies

https://github.com/ahuigo/requests/blob/master/examples/cookie_test.go

resp,_ = session.Get("https://www.httpbin.org/get")
coo := resp.Cookies()
for _, c:= range coo{
    fmt.Println(c.Name,c.Value)
}

Response examples

func TestResponse(t *testing.T) {
    resp, _ := requests.Get("https://httpbin.org/get")
    fmt.Println("Status Code:", resp.StatusCode())
    fmt.Println("Time:", resp.Time())
    fmt.Println("Size:", resp.Size())
    fmt.Println("Headers:")
    for key, value := range resp.Header() {
        fmt.Println(key, "=", value)
    }
    fmt.Println("Cookies:")
    for i, cookie := range resp.Cookies() {
        fmt.Printf("cookie%d: name:%s value:%s\n", i, cookie.Name, cookie.Value)
    }
}

Utils

Build Request

req, err := r.BuildRequest("post", "http://baidu.com/a/b/c", r.Json{
	"age": 1,
})
if err != nil {
	t.Fatal(err)
}
body, _ := ioutil.ReadAll(req.Body)
expectedBody := `{"age":1}`
if string(body) != expectedBody {
	t.Fatal("Failed to build request")
}

Generate curl shell command

req, _ := requests.BuildRequest("post", "https://baidu.com/path?q=curl&v=1", requests.Json{
	"age": 1,
})
curl := requests.BuildCurlRequest(req)
if !regexp.MustCompile(`^curl -X POST .+ 'https://baidu.com/path\?q=curl&v=1'`).MatchString(curl) {
	t.Fatal(`bad curl cmd: ` + curl)
}

Retry request

https://github.com/ahuigo/requests/blob/master/examples/retry_test.go

r := requests.R().
	SetRetryCount(3).
	SetRetryCondition(func(resp *requests.Response, err error) bool {
		if err != nil {
			return true
		}
		var json map[string]interface{}
		resp.Json(&json)
		return json["status"]!="ok"
	})

Feature Support

• Set headers, params, body, json, ....
• Multipart File Uploads
• R-seesion with Cookie Persistence
• Proxy
  • Http Proxy
  • [] Socks5 Proxy
• Authentication
• JSON
• Chunked Requests
• Debug Mode
  • Support Curl Dump
• SetTimeout
• Retry
• [] Support traceInfo(like resty's clientTrace and gout)
• [] Support http stream and callback(notParseResponse)
• [] Remove Global Setting
• [] Support http2
• [] Support retry
• [] Support connection pool
• [] Middleware support?

Thanks

This project is inspired by github.com/asmcos/requests.

Great thanks to it :).