README
¶
requist
Requist is a Go Library to manage HTTP/S Requests easily
Getting started
- API documentation is available via godoc.
- The examples directory contains more elaborate example applications.
Installation
To install Requist package, you need to install Go and set your Go workspace first.
1 - The first need Go installed (version 1.13+ is required). Then you can use the below Go command to install Requist
$ go get -u github.com/dotWicho/requist
And then Import it in your code:
package main
import "github.com/dotWicho/requist"
Or
2 - Use as module in you project (go.mod file):
module myclient
go 1.13
require (
github.com/dotWicho/requist v1.2.2
)
Contributing
- Get started by checking our contribution guidelines.
- Read the dotWicho requist wiki for more technical and design details.
- If you have any questions, just ask!
Documentation
¶
Index ¶
- Constants
- type BodyProvider
- type BodyResponse
- type Requist
- func (r *Requist) Accept(accept string)
- func (r *Requist) AddHeader(key, value string)
- func (r *Requist) AddQueryParam(key, value string)
- func (r *Requist) Base(base string) *Requist
- func (r *Requist) BodyAsForm(body interface{}) *Requist
- func (r *Requist) BodyAsJSON(body interface{}) *Requist
- func (r *Requist) BodyAsText(body interface{}) *Requist
- func (r *Requist) BodyProvider(body BodyProvider) *Requist
- func (r *Requist) BodyResponse(body BodyResponse) *Requist
- func (r *Requist) CleanQueryParams()
- func (r *Requist) Connect(path string, success, failure interface{}) (*Requist, error)
- func (r *Requist) DelHeader(key string)
- func (r *Requist) DelQueryParam(key string)
- func (r *Requist) Delete(path string, success, failure interface{}) (*Requist, error)
- func (r *Requist) Get(path string, success, failure interface{}) (*Requist, error)
- func (r *Requist) GetBasicAuth() string
- func (r *Requist) Head(path string, success, failure interface{}) (*Requist, error)
- func (r *Requist) Method(method string) *Requist
- func (r *Requist) New(baseURL string) *Requist
- func (r *Requist) Options(path string, success, failure interface{}) (*Requist, error)
- func (r *Requist) Patch(path string, success, failure interface{}) (*Requist, error)
- func (r *Requist) Path(path string) *Requist
- func (r *Requist) Post(path string, success, failure interface{}) (*Requist, error)
- func (r *Requist) Put(path string, success, failure interface{}) (*Requist, error)
- func (r *Requist) Request(success, failure interface{}) (*Requist, error)
- func (r *Requist) SetBasicAuth(username, password string) *Requist
- func (r *Requist) SetClientTimeout(timeout time.Duration)
- func (r *Requist) SetClientTransport(transport *http.Transport)
- func (r *Requist) SetHeader(key, value string)
- func (r *Requist) SetQueryParam(key, value string)
- func (r *Requist) StatusCode() int
- func (r *Requist) Trace(path string, success, failure interface{}) (*Requist, error)
Constants ¶
const ( TextContentType string = "text/plain" JsonContentType string = "application/json" FormContentType string = "application/x-www-form-urlencoded" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BodyProvider ¶
type BodyProvider interface {
// ContentType returns the Content-Type of the body.
ContentType() string
// Body returns the io.Reader body.
Body() (io.Reader, error)
}
BodyProvider provides Body content for http.Request attachment.
type BodyResponse ¶
type BodyResponse interface {
// Decode decodes the response into the value pointed to by v.
Accept() string
Decode(resp io.Reader, v interface{}) (err error)
}
BodyResponse decodes http responses into struct values.
type Requist ¶
type Requist struct {
// contains filtered or unexported fields
}
Requist struct Encapsulate an HTTP(S) requests builder and sender
func (*Requist) AddHeader ¶
AddHeader adds the key, value pair in Headers, appending values for existing keys to the key's values. Header keys are canonicalized.
func (*Requist) AddQueryParam ¶
AddQueryParam adds the key, value tuples in QueryParams, appending values for existing keys
func (*Requist) BodyAsForm ¶
BodyAsForm sets the Requests's body from a formProvider
func (*Requist) BodyAsJSON ¶
BodyAsJSON sets the Requests's body from a jsonProvider
func (*Requist) BodyAsText ¶ added in v1.0.0
BodyAsText sets the Requests's body from a textProvider
func (*Requist) BodyProvider ¶
func (r *Requist) BodyProvider(body BodyProvider) *Requist
BodyProvider sets the Requests's body provider from original BodyProvider interface{}
func (*Requist) BodyResponse ¶ added in v1.0.0
func (r *Requist) BodyResponse(body BodyResponse) *Requist
BodyResponse sets the response's body
func (*Requist) CleanQueryParams ¶ added in v0.7.0
func (r *Requist) CleanQueryParams()
CleanQueryParams remove all keys from QueryParams
func (*Requist) DelQueryParam ¶
DelQueryParam remove the key from QueryParams
func (*Requist) GetBasicAuth ¶
GetBasicAuth return the auth stored at the Requist class
func (*Requist) New ¶
New class function
@param Requist class pointer, previous existing instance @return Requist class pointer who clone some data from passed class
func (*Requist) SetBasicAuth ¶
SetBasicAuth sets the Authorization header to use HTTP Basic Authentication
func (*Requist) SetClientTimeout ¶ added in v1.0.2
SetClientTimeout take timeout param and set client Timeout seconds based
func (*Requist) SetClientTransport ¶ added in v1.1.0
SetClientTransport take transport param and set client HTTP Transport
func (*Requist) SetHeader ¶
SetHeader sets the key, value pair in Headers, replacing existing values associated with key. Header keys are canonicalized.
func (*Requist) SetQueryParam ¶
SetQueryParam set the key, value tuples in params to
func (*Requist) StatusCode ¶
StatusCode return the HTTP StatusCode from last request
Source Files
Directories