README
¶
goz
A fantastic HTTP request library used in golang. Inspired by guzzle
Installation
go get -u github.com/o289697/goz
Documentation
API documentation can be found here: https://godoc.org/github.com/o289697/goz
Basic Usage
package main
import (
"github.com/o289697/goz"
)
func main() {
cli := goz.NewClient()
resp, err := cli.Get("http://127.0.0.1:8091/get")
if err != nil {
log.Fatalln(err)
}
fmt.Printf("%T", resp)
// Output: *goz.Response
}
Query Params
- query map
cli := goz.NewClient()
resp, err := cli.Get("http://127.0.0.1:8091/get-with-query", goz.Options{
Query: map[string]interface{}{
"key1": "value1",
"key2": []string{"value21", "value22"},
"key3": "333",
},
})
if err != nil {
log.Fatalln(err)
}
fmt.Printf("%s", resp.GetRequest().URL.RawQuery)
// Output: key1=value1&key2=value21&key2=value22&key3=333
- query string
cli := goz.NewClient()
resp, err := cli.Get("http://127.0.0.1:8091/get-with-query?key0=value0", goz.Options{
Query: "key1=value1&key2=value21&key2=value22&key3=333",
})
if err != nil {
log.Fatalln(err)
}
fmt.Printf("%s", resp.GetRequest().URL.RawQuery)
// Output: key1=value1&key2=value21&key2=value22&key3=333
Post Data
- post form
cli := goz.NewClient()
resp, err := cli.Post("http://127.0.0.1:8091/post-with-form-params", goz.Options{
Headers: map[string]interface{}{
"Content-Type": "application/x-www-form-urlencoded",
},
FormParams: map[string]interface{}{
"key1": "value1",
"key2": []string{"value21", "value22"},
"key3": "333",
},
})
if err != nil {
log.Fatalln(err)
}
body, _ := resp.GetBody()
fmt.Println(body)
// Output: form params:{"key1":["value1"],"key2":["value21","value22"],"key3":["333"]}
- post json
cli := goz.NewClient()
resp, err := cli.Post("http://127.0.0.1:8091/post-with-json", goz.Options{
Headers: map[string]interface{}{
"Content-Type": "application/json",
},
JSON: struct {
Key1 string `json:"key1"`
Key2 []string `json:"key2"`
Key3 int `json:"key3"`
}{"value1", []string{"value21", "value22"}, 333},
})
if err != nil {
log.Fatalln(err)
}
body, _ := resp.GetBody()
fmt.Println(body)
// Output: json:{"key1":"value1","key2":["value21","value22"],"key3":333}
Request Headers
cli := goz.NewClient()
resp, err := cli.Post("http://127.0.0.1:8091/post-with-headers", goz.Options{
Headers: map[string]interface{}{
"User-Agent": "testing/1.0",
"Accept": "application/json",
"X-Foo": []string{"Bar", "Baz"},
},
})
if err != nil {
log.Fatalln(err)
}
headers := resp.GetRequest().Header["X-Foo"]
fmt.Println(headers)
// Output: [Bar Baz]
Response
cli := goz.NewClient()
resp, err := cli.Get("http://127.0.0.1:8091/get")
if err != nil {
log.Fatalln(err)
}
body, err := resp.GetBody()
if err != nil {
log.Fatalln(err)
}
fmt.Printf("%T", body)
// Output: goz.ResponseBody
part := body.Read(30)
fmt.Printf("%T", part)
// Output: []uint8
contents := body.GetContents()
fmt.Printf("%T", contents)
// Output: string
fmt.Println(resp.GetStatusCode())
// Output: 200
fmt.Println(resp.GetReasonPhrase())
// Output: OK
headers := resp.GetHeaders()
fmt.Printf("%T", headers)
// Output: map[string][]string
flag := resp.HasHeader("Content-Type")
fmt.Printf("%T", flag)
// Output: bool
header := resp.GetHeader("content-type")
fmt.Printf("%T", header)
// Output: []string
headerLine := resp.GetHeaderLine("content-type")
fmt.Printf("%T", headerLine)
// Output: string
Proxy
cli := goz.NewClient()
resp, err := cli.Get("https://www.fbisb.com/ip.php", goz.Options{
Timeout: 5.0,
Proxy: "http://127.0.0.1:1087",
})
if err != nil {
log.Fatalln(err)
}
fmt.Println(resp.GetStatusCode())
// Output: 200
Timeout
cli := goz.NewClient(goz.Options{
Timeout: 0.9,
})
resp, err := cli.Get("http://127.0.0.1:8091/get-timeout")
if err != nil {
if resp.IsTimeout() {
fmt.Println("timeout")
// Output: timeout
return
}
}
fmt.Println("not timeout")
License
Copyright (c) 2017-present, idoubi
Documentation
¶
Index ¶
- type FormData
- type Options
- type Request
- func (r *Request) Delete(uri string, opts ...Options) (*Response, error)
- func (r *Request) Get(uri string, opts ...Options) (*Response, error)
- func (r *Request) Options(uri string, opts ...Options) (*Response, error)
- func (r *Request) Patch(uri string, opts ...Options) (*Response, error)
- func (r *Request) Post(uri string, opts ...Options) (*Response, error)
- func (r *Request) Put(uri string, opts ...Options) (*Response, error)
- func (r *Request) Request(method, uri string, opts ...Options) (*Response, error)
- func (r *Request) SetOptions(opts Options)
- type Response
- func (r *Response) Err() error
- func (r *Response) GetBody() (ResponseBody, error)
- func (r *Response) GetHeader(name string) []string
- func (r *Response) GetHeaderLine(name string) string
- func (r *Response) GetHeaders() map[string][]string
- func (r *Response) GetParsedBody() (*gjson.Result, error)
- func (r *Response) GetReasonPhrase() string
- func (r *Response) GetRequest() *http.Request
- func (r *Response) GetStatusCode() int
- func (r *Response) HasHeader(name string) bool
- func (r *Response) IsTimeout() bool
- func (r *Response) Stream() chan []byte
- type ResponseBody
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FormData ¶
type FormData struct {
Name string
Contents []byte
Filename string
Filepath string
Headers map[string]interface{}
}
FormData: multipart form-data
type Options ¶
type Options struct {
Debug bool
BaseURI string
Timeout float32
Query interface{}
Headers map[string]interface{}
Cookies interface{}
FormParams map[string]interface{}
JSON interface{}
XML interface{}
Multipart []FormData
Proxy string
Certificates []tls.Certificate
// contains filtered or unexported fields
}
Options object
type Request ¶
type Request struct {
// contains filtered or unexported fields
}
Request object
func (*Request) SetOptions ¶
SetOptions: set request options
type Response ¶
type Response struct {
// contains filtered or unexported fields
}
Response response object
func (*Response) GetBody ¶
func (r *Response) GetBody() (ResponseBody, error)
GetBody parse response body
func (*Response) GetHeaderLine ¶
GetHeaderLine get a single response header
func (*Response) GetHeaders ¶
GetHeaders get response headers
func (*Response) GetParsedBody ¶
GetParsedBody parse response body with gjson
func (*Response) GetReasonPhrase ¶
GetReasonPhrase get response reason phrase
func (*Response) GetRequest ¶
GetRequest get request object
func (*Response) GetStatusCode ¶
GetStatusCode get response status code
type ResponseBody ¶
type ResponseBody []byte
ResponseBody response body
func (ResponseBody) GetContents ¶
func (r ResponseBody) GetContents() string
GetContents format response body as string
func (ResponseBody) Read ¶
func (r ResponseBody) Read(length int) []byte
Read get slice of response body
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.