request

README

Request

request is an intuitive and flexible HTTP client written in Go. Inspired by the simplicity of the project req, this library aims to provide a higher level of abstraction for handling HTTP requests and responses. With a wide range of customization options, it makes sending HTTP requests and handling responses simpler and more efficient.

Features

• Support for all basic HTTP methods: GET, POST, PATCH, PUT, DELETE.
• Built-in JSON and form data support for request bodies.
• Cookie jar support for easier cookie management.
• Dynamic and easy setting of query parameters and headers.
• Integrated basic authentication.
• Customizable timeouts and transport settings.
• Context support for cancellable and timeout requests.
• String, byte array, and io.Reader support for request bodies.
• Helper methods for response handling: read as string, read all, convert to JSON, save to file.

Example Usage

package main

import (
	"context"
	"fmt"
	"time"

	"github.com/faceair/request"
)

func main() {
	client := request.New()

	client.SetBaseURL("https://api.github.com").
		SetBaseHeaders(request.Headers{
			"Accept": "application/vnd.github.v3+json",
		})

	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
	defer cancel()

	resp, err := client.Get(ctx, "/users/octocat")
	if err != nil {
		fmt.Println("Error:", err)
		return
	}

	fmt.Println("Response:", resp.String())
}

This will send a GET request to https://api.github.com/users/octocat with the Accept header set as application/vnd.github.v3+json and a timeout of 5 seconds.

License

MIT.

Documentation

Index

• func BodyJSON(v any) *bodyJSON
• type Client
  • func New() *Client
  • func (r *Client) Delete(ctx context.Context, uri string, params ...any) (*Resp, error)
  • func (r *Client) Do(ctx context.Context, method, uri string, params ...any) (*Resp, error)
  • func (r *Client) EnableHTTPBalance(cacheExpire time.Duration) *Client
  • func (r *Client) Get(ctx context.Context, uri string, params ...any) (*Resp, error)
  • func (r *Client) Patch(ctx context.Context, uri string, params ...any) (*Resp, error)
  • func (r *Client) Post(ctx context.Context, uri string, params ...any) (*Resp, error)
  • func (r *Client) Put(ctx context.Context, uri string, params ...any) (*Resp, error)
  • func (r *Client) SetBaseClient(client HTTPClient) *Client
  • func (r *Client) SetBaseHeaders(headers Headers) *Client
  • func (r *Client) SetBaseURL(baseURL string) *Client
  • func (r *Client) SetBaseURLs(baseURLs []string) *Client
  • func (r *Client) SetBasicAuth(username, password string) *Client
  • func (r *Client) SetDialTimeout(timeout time.Duration) *Client
  • func (r *Client) SetMaxIdleConns(maxIdleConns int) *Client
  • func (r *Client) SetTimeout(timeout time.Duration) *Client
• type DNSBalancer
  • func (lb *DNSBalancer) DialContext(ctx context.Context, network, addr string) (net.Conn, error)
• type DialContext
• type GetBody
• type HTTPBalancer
  • func (lb *HTTPBalancer) Do(req *http.Request) (*http.Response, error)
• type HTTPClient
• type Headers
• type MapForm
• type MapJSON
• type MapMultipartForm
• type Query
• type Resp
  • func Delete(ctx context.Context, uri string, params ...interface{}) (*Resp, error)
  • func Get(ctx context.Context, uri string, params ...interface{}) (*Resp, error)
  • func Patch(ctx context.Context, uri string, params ...interface{}) (*Resp, error)
  • func Post(ctx context.Context, uri string, params ...interface{}) (*Resp, error)
  • func Put(ctx context.Context, uri string, params ...interface{}) (*Resp, error)
  • func (r *Resp) ReadAll() ([]byte, error)
  • func (r *Resp) String() string
  • func (r *Resp) ToFile(filename string) error
  • func (r *Resp) ToJSON(v any) error

Functions

func BodyJSON

func BodyJSON(v any) *bodyJSON

Types

type Client

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

func New

func New() *Client

func (*Client) Delete

func (r *Client) Delete(ctx context.Context, uri string, params ...any) (*Resp, error)

func (*Client) Do

func (r *Client) Do(ctx context.Context, method, uri string, params ...any) (*Resp, error)

func (*Client) EnableHTTPBalance

func (r *Client) EnableHTTPBalance(cacheExpire time.Duration) *Client

func (*Client) Get

func (r *Client) Get(ctx context.Context, uri string, params ...any) (*Resp, error)

func (*Client) Patch

func (r *Client) Patch(ctx context.Context, uri string, params ...any) (*Resp, error)

func (*Client) Post

func (r *Client) Post(ctx context.Context, uri string, params ...any) (*Resp, error)

func (*Client) Put

func (r *Client) Put(ctx context.Context, uri string, params ...any) (*Resp, error)

func (*Client) SetBaseClient

func (r *Client) SetBaseClient(client HTTPClient) *Client

func (*Client) SetBaseHeaders

func (r *Client) SetBaseHeaders(headers Headers) *Client

func (*Client) SetBaseURL

func (r *Client) SetBaseURL(baseURL string) *Client

func (*Client) SetBaseURLs

func (r *Client) SetBaseURLs(baseURLs []string) *Client

func (*Client) SetBasicAuth

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

func (*Client) SetDialTimeout

func (r *Client) SetDialTimeout(timeout time.Duration) *Client

func (*Client) SetMaxIdleConns

func (r *Client) SetMaxIdleConns(maxIdleConns int) *Client

func (*Client) SetTimeout

func (r *Client) SetTimeout(timeout time.Duration) *Client

type DNSBalancer

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

func (*DNSBalancer) DialContext

func (lb *DNSBalancer) DialContext(ctx context.Context, network, addr string) (net.Conn, error)

type DialContext

type DialContext func(ctx context.Context, network, addr string) (net.Conn, error)

type GetBody

type GetBody func() (io.ReadCloser, error)

type HTTPBalancer

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

func (*HTTPBalancer) Do

func (lb *HTTPBalancer) Do(req *http.Request) (*http.Response, error)

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type Headers

type Headers map[string]string

type MapForm

type MapForm map[string]string

type MapJSON

type MapJSON map[string]any

type MapMultipartForm

type MapMultipartForm map[string]any

type Query

type Query map[string]string

type Resp

type Resp struct {
	*http.Response
}

func Delete

func Delete(ctx context.Context, uri string, params ...interface{}) (*Resp, error)

func Get

func Get(ctx context.Context, uri string, params ...interface{}) (*Resp, error)

func Patch

func Patch(ctx context.Context, uri string, params ...interface{}) (*Resp, error)

func Post

func Post(ctx context.Context, uri string, params ...interface{}) (*Resp, error)

func Put

func Put(ctx context.Context, uri string, params ...interface{}) (*Resp, error)

func (*Resp) ReadAll

func (r *Resp) ReadAll() ([]byte, error)

func (*Resp) String

func (r *Resp) String() string

func (*Resp) ToFile

func (r *Resp) ToFile(filename string) error

func (*Resp) ToJSON

func (r *Resp) ToJSON(v any) error