okhttp

README

okhttp

Documentation

Index

• Constants
• Variables
• type H
• type Handler
• type Request
  • func Connect(uri string) (*Request, error)
  • func Delete(uri string) (*Request, error)
  • func Get(uri string) (*Request, error)
  • func Head(uri string) (*Request, error)
  • func NewRequest(method, uri string) (r *Request, err error)
  • func Options(uri string) (*Request, error)
  • func Patch(uri string) (*Request, error)
  • func Post(uri string) (*Request, error)
  • func Put(uri string) (*Request, error)
  • func Trace(uri string) (*Request, error)
  • func (r *Request) AddHeader(key, value string) *Request
  • func (r *Request) Do() (*Response, error)
  • func (r *Request) GetHeaders() H
  • func (r *Request) Method() string
  • func (r *Request) SetBasicAuth(username, password string) *Request
  • func (r *Request) SetBody(body io.Reader) *Request
  • func (r *Request) SetCookie(cookie *http.Cookie) *Request
  • func (r *Request) SetDebug(d bool) *Request
  • func (r *Request) SetForm(v url.Values) *Request
  • func (r *Request) SetHeader(key, value string) *Request
  • func (r *Request) SetHeaders(headers map[string]string) *Request
  • func (r *Request) SetJSON(v interface{}) *Request
  • func (r *Request) SetPrintBody(d bool) *Request
  • func (r *Request) SetProxy(proxyURL string) *Request
  • func (r *Request) SetRedirects(i bool) *Request
  • func (r *Request) SetReferer(referer string) *Request
  • func (r *Request) SetTimeOut(d time.Duration) *Request
  • func (r *Request) SetUserAgent(value string) *Request
  • func (r *Request) URL() *url.URL
  • func (r *Request) URLString() string
• type Response
  • func (r *Response) GetBody() []byte
  • func (r *Response) GetCookies() []*http.Cookie
  • func (r *Response) GetHeader(key string) string
  • func (r *Response) GetHeaders() H
  • func (r *Response) GetJSON(v interface{}) error
  • func (r *Response) GetRequest() *Request
  • func (r *Response) GetStatus() int
  • func (r *Response) String() string

Constants

const (
	// Version
	Version = "v0.1.0"
)

Variables

var DefaultRequestTimeOut = 5 * time.Second

DefaultRequestTimeOut set a default request time out

var NoMatchHttpMethod = errors.New("no match request method")

NoMatchHttpMethod is errors

Types

type H

type H map[string]interface{}

type Handler

type Handler func(*Response)

type Request

type Request struct {
	// contains filtered or unexported fields
}

func Connect

func Connect(uri string) (*Request, error)

Connect created a connect request

func Delete

func Delete(uri string) (*Request, error)

Delete created a delete request

func Get

func Get(uri string) (*Request, error)

Get created a get request

func Head

func Head(uri string) (*Request, error)

Head created a head request

func NewRequest

func NewRequest(method, uri string) (r *Request, err error)

NewRequest 建立一个请求

func Options

func Options(uri string) (*Request, error)

Options created a options request

func Patch

func Patch(uri string) (*Request, error)

Patch created a patch request

func Post

func Post(uri string) (*Request, error)

Post created a post request

func Put

func Put(uri string) (*Request, error)

Put created a put request

func Trace

func Trace(uri string) (*Request, error)

Trace created a trace request

func (*Request) AddHeader

func (r *Request) AddHeader(key, value string) *Request

AddHeader add request header

func (*Request) Do

func (r *Request) Do() (*Response, error)

Do returns response

func (*Request) GetHeaders

func (r *Request) GetHeaders() H

GetHeaders get all request header

func (*Request) Method

func (r *Request) Method() string

Method get http method

func (*Request) SetBasicAuth

func (r *Request) SetBasicAuth(username, password string) *Request

SetBasicAuth set username and password to header

func (*Request) SetBody

func (r *Request) SetBody(body io.Reader) *Request

SetBody sets request body

func (*Request) SetCookie

func (r *Request) SetCookie(cookie *http.Cookie) *Request

SetCookie set a cookie request header

func (*Request) SetDebug

func (r *Request) SetDebug(d bool) *Request

SetDebug set debug mode

func (*Request) SetForm

func (r *Request) SetForm(v url.Values) *Request

SetForm sets request form and returns response

func (*Request) SetHeader

func (r *Request) SetHeader(key, value string) *Request

SetHeader set request header

func (*Request) SetHeaders

func (r *Request) SetHeaders(headers map[string]string) *Request

SetHeaders multi set request header

func (*Request) SetJSON

func (r *Request) SetJSON(v interface{}) *Request

SetJSON sets request JSON and returns response

func (*Request) SetPrintBody

func (r *Request) SetPrintBody(d bool) *Request

SetPrintBody set debug mode rely Debug

func (*Request) SetProxy

func (r *Request) SetProxy(proxyURL string) *Request

SetProxy set a referer request header

func (*Request) SetRedirects

func (r *Request) SetRedirects(i bool) *Request

SetRedirects set default request allow redirects

func (*Request) SetReferer

func (r *Request) SetReferer(referer string) *Request

SetReferer set a referer request header

func (*Request) SetTimeOut

func (r *Request) SetTimeOut(d time.Duration) *Request

SetTimeOut set default request time

func (*Request) SetUserAgent

func (r *Request) SetUserAgent(value string) *Request

SetUserAgent set user-agent

func (*Request) URL

func (r *Request) URL() *url.URL

URL url object

func (*Request) URLString

func (r *Request) URLString() string

URLString url string

type Response

type Response struct {
	// contains filtered or unexported fields
}

Response r

func (*Response) GetBody

func (r *Response) GetBody() []byte

GetBody returns response body

func (*Response) GetCookies

func (r *Response) GetCookies() []*http.Cookie

GetCookies returns response cookies slice

func (*Response) GetHeader

func (r *Response) GetHeader(key string) string

GetHeader returns response header by name

func (*Response) GetHeaders

func (r *Response) GetHeaders() H

GetHeaders return response headers

func (*Response) GetJSON

func (r *Response) GetJSON(v interface{}) error

GetJSON unmarshal JSON response to struct

func (*Response) GetRequest

func (r *Response) GetRequest() *Request

GetRequest returns initial request

func (*Response) GetStatus

func (r *Response) GetStatus() int

GetStatus returns response status code

func (*Response) String

func (r *Response) String() string

String returns response body as string