README
¶
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 -
thread(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", "CONNECT", "TRACE"
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 data
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
resp, err := nic.Get(url, &nic.H{
Cookies : nic.KV{
"cookie1" : "nic",
},
})
request with files
resp, err := nic.Post(url, &nic.H{
Files : nic.F{
"file" : nic.KV{
// path of file, filename will be `nic.go`
"filename" : `/home/nic/nic.go`,
"token" : "0xff",
},
},
})
request with JSON
resp, err := nic.Post(url, &nic.H{
JSON : nic.KV{
"nic" : "nic",
}
})
request with unencoded message
resp, err := nic.Post(url, &nic.H{
Raw : "post body which is unencoded",
})
all the parameters
H struct {
AllowRedirect bool
Timeout int64
Data KV
Raw string
Headers KV
Cookies KV
Auth KV
Proxy string
JSON KV
Files F
}
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 save server'sset-cookie header
session := &nic.Session{}
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, _ := nil.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, _ := nil.Get(url, nil)
err := resp.SetEncode("gbk")
if err == nil {
fmt.Println(resp.Text)
}
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
Documentation
¶
Index ¶
- Variables
- type F
- type H
- type KV
- type Response
- func Connect(url string, options *H) (*Response, error)
- func Delete(url string, options *H) (*Response, error)
- func Get(url string, options *H) (*Response, error)
- func Head(url string, options *H) (*Response, error)
- func Options(url string, options *H) (*Response, error)
- func Patch(url string, options *H) (*Response, error)
- func Post(url string, options *H) (*Response, error)
- func Put(url string, options *H) (*Response, error)
- func Trace(url string, options *H) (*Response, error)
- type Session
- func (s *Session) ClearCookies()
- func (s *Session) Connect(url string, options *H) (*Response, error)
- func (s *Session) Delete(url string, options *H) (*Response, error)
- func (s *Session) Get(url string, options *H) (*Response, error)
- func (s *Session) GetRequest() *http.Request
- func (s *Session) Head(url string, options *H) (*Response, error)
- func (s *Session) Options(url string, options *H) (*Response, error)
- func (s *Session) Patch(url string, options *H) (*Response, error)
- func (s *Session) Post(url string, options *H) (*Response, error)
- func (s *Session) Put(url string, options *H) (*Response, error)
- func (s *Session) Request(method string, urlStr string, options *H) (*Response, error)
- func (s *Session) Trace(url string, options *H) (*Response, error)
Constants ¶
This section is empty.
Variables ¶
var ( // ErrInvalidMethod will be throwed when method not in // [HEAD, GET, POST, DELETE, OPTIONS, PUT, PATCH, CONNECT, TRACE] ErrInvalidMethod = errors.New("nic: Method is invalid") // ErrFileInfo will be throwed when fileinfo is invalid ErrFileInfo = errors.New("nic: Invalid file information") // ErrParamConflict will be throwed when options params conflict // e.g. files + data // json + data // ... ErrParamConflict = errors.New("nic: Options param conflict") // ErrUnrecognizedEncoding will be throwed while changing response encoding // if encoding is not recognized ErrUnrecognizedEncoding = errors.New("nic: Unrecognized encoding") // ErrNotJsonResponse will be throwed when response not a json // but invoke Json() method ErrNotJsonResponse = errors.New("nic: Not a Json response") )
Functions ¶
This section is empty.
Types ¶
type F ¶
F is for file-upload request
map[string]KV{
"file1" : KV{
// path of file
"filename" : "1.txt",
"token" : "abc",
},
"file2" : KV{...},
}
type H ¶
type H struct {
AllowRedirect bool
Timeout int64
Data KV
Raw string
Headers KV
Cookies KV
Auth KV
Proxy string
JSON KV
Files F
}
H struct is options for request and http client
type Response ¶
type Response struct {
*http.Response
Text string
Bytes []byte
// contains filtered or unexported fields
}
Response is the wrapper for http.Response
type Session ¶
type Session struct {
Client *http.Client
Cookies []*http.Cookie
// contains filtered or unexported fields
}
Session is the wrapper for http.Client and http.Request
func (*Session) GetRequest ¶ added in v0.1.1
GetRequest returns nic.Session.request
Source Files