Nic
English | 中文
Nic is a HTTP request client which has elegant, easy-to-use API
Features
-
wrapper of HTTP std lib, provids elegant and easy-to-use API
-
keep session via
nic.Sessionstructure,nic.Sessionis go-routine safe
Installation
To install nic, enter the following command
$ go get -v -u github.com/eddieivan01/nic
Quick start
Do a HTTP request like this
resp, err := nic.Get("http://example.com", nil)
if err != nil {
log.Fatal(err.Error())
}
fmt.Println(resp.Text)Documentation
do a basic request
nic could do these methods' request
"HEAD", "GET", "POST", "DELETE", "OPTIONS", "PUT", "PATCH"
import (
"fmt"
"github.com/eddieivan01/nic"
)
func main() {
url := "http://example.com"
resp, err := nic.Get(url, nil)
if err != nil {
log.Fatal(err.Error())
}
fmt.Println(resp.Text)
}post request with some form data
as you see, all requests' parameters are passed by nic.H, and the inner is saved in nic.KV, it's actually map[string]interface{}
resp, err := nic.Post(url, nic.H{
Data : nic.KV{
"nic" : "nic",
},
Headers : nic.KV{
"X-Forwarded-For" : "127.0.0.1",
},
})request with cookies
of course, you can also set it in Headers
resp, err := nic.Get(url, nic.H{
Cookies : nic.KV{
"cookie" : "nic",
},
})request with files
you can upload files with files' name + files' content which is []byte type, and can also upload via local file path
while uploading a file, you can set multipart form's field name, filename and MIME type
for more convenient setting files parameters, you can invoke in a chain to set filename and MIME type
resp, err := nic.Post(url, nic.H{
Files : nic.KV{
"file1": nic.File(
"nic.go",
[]byte("package nic")),
"file2": nic.FileFromPath("./nic.go").
MIME("text/plain").
FName("nic"),
},
})request with JSON
resp, err := nic.Post(url, nic.H{
JSON : nic.KV{
"nic" : "nic",
}
})request with unencoded raw message
resp, err := nic.Post(url, nic.H{
Raw : "post body which is unencoded",
})using chunked transfer
The default is not to use chunked transfer
enable the transfer-encoding: chunked
resp, _ := nic.Get(url, nic.H{
Chunked: true,
})set query params
resp, err := nic.Get(url, nic.H {
Params: nic.KV {
"a": "1",
},
})all the parameters you could set
H struct {
Params KV
Data KV
Raw string
Headers KV
Cookies KV
Auth KV
Proxy string
JSON KV
Files KV
AllowRedirect bool
Timeout int64
Chunked bool
DisableKeepAlives bool
DisableCompression bool
SkipVerifyTLS bool
}NOTICE
nic.H can only have one of the following four parameters
H.Raw, H.Data, H.Files, H.JSON
request with session, which could handle server's set-cookie header
session := nic.NewSession()
resp, err := session.Post("http://example.com/login", nic.H{
Data : nic.KV{
"uname" : "nic",
"passwd" : "nic",
},
})
// ......
resp, err = session.Get("http://example.com/userinfo", nil)handle response
resp, _ := nic.Get(url, nil)
fmt.Println(resp.Text)
fmt.Println(resp.Bytes)handle JSON response
resp, _ := nic.Get(url, nil)
type S struct {
P1 string `json:"p1"`
P2 string `json:"p2"`
}
s := &S{}
err := resp.JSON(&s)
if err == nil {
fmt.Println(s.P1, s.P2)
}change response's encoding
SetEncode will convert resp.Bytes to resp.Text if encoding is changed every time be called
resp, _ := nic.Get(url, nil)
err := resp.SetEncode("gbk")
if err == nil {
fmt.Println(resp.Text)
}save response's content as a file
resp, _ := nic.Get("http://example.com/1.jpg", nil)
err := resp.SaveFile("1.jpg")register a request/response hook
session := nic.NewSession()
session.RegisterBeforeReqHook(func(r *http.Request) error {
r.URL.RawQuery = "nic=nic"
return nil
})
session.RegisterAfterRespHook(func(r *http.Response) error {
r.Header.Set("nic", "nic")
return nil
})
session.Get(url, nil)QA
-
Q:
How to get origin
*http.Requestfromnic.Session?A:
by
nic.Session.GetRequestmethod -
Q:
How to pass origin
*http.Responseto goquery-like DOM-parsing-libs fromnic.Response?A:
use
resp, _ := nic.Get(...); resp.Responseto access origin anonymous structure*http.Response; and(*http.Response).Body's IO.Readerhas been saved, you can use*http.Responseas if it were the original structure -
Q:
Redirection is allowed 10 times by default, how could I increase the number?
A:
by access
nic.Session.Clientthen change its CheckRedirect property -
Q:
How to use the chunked transfer-encoding?
A:
by nic.H{Chunked: true}