requester

package module

v1.1.0 Latest Latest Go to latest Published: Dec 2, 2022 License: MIT Imports: 11 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/nobina/go-requester

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Code(err error) int
func StatusCode(err error) int
type Client
- func NewClient(opts ...ClientOption) *Client
- func (c *Client) Do(opts ...RequestOption) (*Response, error)
type ClientOption
type Request
- func NewRequest(opts ...RequestOption) (*Request, error)
type RequestOption
type RequestValidatorFunc
type Response
- func (r *Response) JSON(v interface{}) error
- func (r *Response) XML(v interface{}) error

Constants ¶

View Source

const (
	CodeUnknown         int = 0
	CodeInvalidBody     int = 1
	CodeBadResponseCode int = 2
	CodeEncodingError   int = 3
	CodeInvalidForm     int = 4
	CodeMissingURL      int = 5
)

Variables ¶

This section is empty.

Functions ¶

func Code ¶

func Code(err error) int

func StatusCode ¶ added in v1.0.7

func StatusCode(err error) int

Types ¶

type Client ¶

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

func NewClient ¶

func NewClient(opts ...ClientOption) *Client

func (*Client) Do ¶

func (c *Client) Do(opts ...RequestOption) (*Response, error)

type ClientOption ¶

type ClientOption func(*Client)

func WithDefaultOptions ¶

func WithDefaultOptions(opts ...RequestOption) ClientOption

func WithHTTPClient ¶

func WithHTTPClient(httpClient *http.Client) ClientOption

func WithRequestValidation ¶

func WithRequestValidation(fn RequestValidatorFunc) ClientOption

type Request ¶

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

func NewRequest ¶

func NewRequest(opts ...RequestOption) (*Request, error)

type RequestOption ¶

type RequestOption func(*Request) error

func WithBody ¶

func WithBody(v interface{}) RequestOption

func WithContext ¶ added in v1.0.10

func WithContext(ctx context.Context) RequestOption

func WithForm ¶

func WithForm(v interface{}) RequestOption

func WithHeader ¶

func WithHeader(header map[string]string) RequestOption

func WithHost ¶

func WithHost(host string) RequestOption

func WithJSON ¶

func WithJSON(v interface{}) RequestOption

func WithMethod ¶

func WithMethod(method string) RequestOption

func WithPath ¶

func WithPath(path string) RequestOption

func WithQuery ¶

func WithQuery(query url.Values) RequestOption

func WithRequestLogger ¶ added in v1.0.10

func WithRequestLogger(w io.Writer) RequestOption

func WithRequestTrace ¶ added in v1.1.0

func WithRequestTrace(ctx context.Context) RequestOption

WithRequestTrace returns a RequestOption that will trace the request using datadog. Side Effect: adds context to request

func WithResponseLogger ¶ added in v1.0.10

func WithResponseLogger(w io.Writer) RequestOption

func WithURL ¶

func WithURL(url string) RequestOption

func WithXML ¶

func WithXML(v interface{}) RequestOption

type RequestValidatorFunc ¶

type RequestValidatorFunc func(*http.Request) error

type Response ¶

type Response struct {
	*http.Response
}

func (*Response) JSON ¶

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

func (*Response) XML ¶

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL