httpx

README

httpx

HTTP common abstractions and helpers in Go.

Features

• Simple.
• Dependency-free.

See docs and GUIDE.md for more details.

Install

Go version 1.18+

go get github.com/go-distsys/httpx

Example

TODO

See example_test.go.

License

MIT License.

Documentation

Index

• func Is1xx(code int) bool
• func Is2xx(code int) bool
• func Is3xx(code int) bool
• func Is4xx(code int) bool
• func Is5xx(code int) bool
• func MustConnectRequest(ctx context.Context, url string, body io.Reader) *http.Request
• func MustDeleteRequest(ctx context.Context, url string, body io.Reader) *http.Request
• func MustGetRequest(ctx context.Context, url string) *http.Request
• func MustHeadRequest(ctx context.Context, url string) *http.Request
• func MustOptionsRequest(ctx context.Context, url string, body io.Reader) *http.Request
• func MustPatchRequest(ctx context.Context, url string, body io.Reader) *http.Request
• func MustPostRequest(ctx context.Context, url string, body io.Reader) *http.Request
• func MustPutRequest(ctx context.Context, url string, body io.Reader) *http.Request
• func MustTraceRequest(ctx context.Context, url string) *http.Request
• func NewConnectRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)
• func NewDeleteRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)
• func NewGetRequest(ctx context.Context, url string) (*http.Request, error)
• func NewHeadRequest(ctx context.Context, url string) (*http.Request, error)
• func NewOptionsRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)
• func NewPatchRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)
• func NewPostRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)
• func NewPutRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)
• func NewRequest(ctx context.Context, method, url string, body io.Reader) (*http.Request, error)
• func NewTraceRequest(ctx context.Context, url string) (*http.Request, error)
• type Doer

Functions

func Is1xx

func Is1xx(code int) bool

Is1xx reports whether code is in range [100, 200).

func Is2xx

func Is2xx(code int) bool

Is2xx reports whether code is in range [200, 300).

func Is3xx

func Is3xx(code int) bool

Is3xx reports whether code is in range [300, 400).

func Is4xx

func Is4xx(code int) bool

Is4xx reports whether code is in range [400, 500).

func Is5xx

func Is5xx(code int) bool

Is5xx reports whether code is in range [500, 600).

func MustConnectRequest

func MustConnectRequest(ctx context.Context, url string, body io.Reader) *http.Request

MustConnectRequest returns a new http.Request with CONNECT method.

func MustDeleteRequest

func MustDeleteRequest(ctx context.Context, url string, body io.Reader) *http.Request

MustDeleteRequest returns a new http.Request with DELETE method.

func MustGetRequest

func MustGetRequest(ctx context.Context, url string) *http.Request

MustGetRequest returns a new http.Request with GET method.

func MustHeadRequest

func MustHeadRequest(ctx context.Context, url string) *http.Request

MustHeadRequest returns a new http.Request with HEAD method.

func MustOptionsRequest

func MustOptionsRequest(ctx context.Context, url string, body io.Reader) *http.Request

MustOptionsRequest returns a new http.Request with OPTIONS method.

func MustPatchRequest

func MustPatchRequest(ctx context.Context, url string, body io.Reader) *http.Request

MustPatchRequest returns a new http.Request with PATCH method.

func MustPostRequest

func MustPostRequest(ctx context.Context, url string, body io.Reader) *http.Request

MustPostRequest returns a new http.Request with POST method.

func MustPutRequest

func MustPutRequest(ctx context.Context, url string, body io.Reader) *http.Request

MustPutRequest returns a new http.Request with PUT method.

func MustTraceRequest

func MustTraceRequest(ctx context.Context, url string) *http.Request

MustTraceRequest returns a new http.Request with TRACE method.

func NewConnectRequest

func NewConnectRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)

NewConnectRequest returns a new http.Request with CONNECT method.

func NewDeleteRequest

func NewDeleteRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)

NewDeleteRequest returns a new http.Request with DELETE method.

func NewGetRequest

func NewGetRequest(ctx context.Context, url string) (*http.Request, error)

NewGetRequest returns a new http.Request with GET method.

func NewHeadRequest

func NewHeadRequest(ctx context.Context, url string) (*http.Request, error)

NewHeadRequest returns a new http.Request with HEAD method.

func NewOptionsRequest

func NewOptionsRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)

NewOptionsRequest returns a new http.Request with OPTIONS method.

func NewPatchRequest

func NewPatchRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)

NewPatchRequest returns a new http.Request with PATCH method.

func NewPostRequest

func NewPostRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)

NewPostRequest returns a new http.Request with POST method.

func NewPutRequest

func NewPutRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)

NewPutRequest returns a new http.Request with PUT method.

func NewRequest

func NewRequest(ctx context.Context, method, url string, body io.Reader) (*http.Request, error)

NewRequest returns a new http.Request.

func NewTraceRequest

func NewTraceRequest(ctx context.Context, url string) (*http.Request, error)

NewTraceRequest returns a new http.Request with TRACE method.

Types

type Doer

type Doer interface {
	Do(req *http.Request) (resp *http.Response, error error)
}

Doer represents a HTTP client.