fastshot

package module
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 10, 2024 License: MIT Imports: 15 Imported by: 2

README

Logo fast-shot

A Fluent Go REST Client Library

Go Report Badge Go Doc Badge Converage Actions Badge Codecov Badge License Badge Mentioned in Awesome Go

Fast Shot is a robust, feature-rich, and highly configurable HTTP client for Go. Crafted with modern Go practices in mind, it offers a fluent, chainable API that allows for clean, idiomatic code.

Why Fast Shot?

  • Fluent & Chainable API: Write expressive, readable, and flexible HTTP client code.
  • Ease of Use: Reduce boilerplate, making HTTP requests as straightforward as possible.
  • Rich Features: From headers to query parameters and JSON support, Fast Shot covers your needs.

Features 🌟

  • Fluent API for HTTP requests
  • Extensible authentication
  • Customizable HTTP headers
  • Query parameter manipulation
  • JSON request and response support
  • Built-in error handling
  • Well-tested

Installation 🔧

To install Fast Shot, run the following command:

go get github.com/opus-domini/fast-shot

Quick Start 🚀

Here's how you can make a simple POST using Fast Shot:

package main

import (
    "fmt"
    fastshot "github.com/opus-domini/fast-shot"
    "github.com/opus-domini/fast-shot/constant/mime"
)

func main() {
    client := fastshot.NewClient("https://api.example.com").
        Auth().BearerToken("your_token_here").
        Build()

    payload := map[string]interface{}{
        "key1": "value1",
        "key2": "value2",
    }

    response, err := client.POST("/endpoint").
        Header().AddAccept(mime.JSON).
        Body().AsJSON(payload).
        Send()
	
    // Process response...
}

Advanced Usage 🛠️

Fluent API

Easily chain multiple settings in a single line:

client := fastshot.NewClient("https://api.example.com").
    Auth().BearerToken("your-bearer-token").
    Header().Add("My-Header", "My-Value").
    Config().SetTimeout(time.Second * 30).
    Build()

Retry Mechanism

Handle transient failures, enhancing the reliability of your HTTP requests:

client.POST("/resource").
    Retry().Set(2, time.Second * 2).
    Send()

Out-of-the-Box Support for Client Load Balancing

Effortlessly manage multiple endpoints:

client := fastshot.NewClientLoadBalancer([]string{
    "https://api1.example.com",
    "https://api2.example.com",
    "https://api3.example.com",
    }).
    Config().SetTimeout(time.Second * 10).
    Build()

This feature allows you to distribute network traffic across several servers, enhancing the performance and reliability of your applications.

Authentication

Fast Shot supports various types of authentication:

// Bearer Token
builder.Auth().BearerToken("your-bearer-token")

// Basic Authentication
builder.Auth().BasicAuth("username", "password")

// Custom Authentication
builder.Auth().Set("custom-authentication-header")

Custom Headers and Cookies

Add your own headers and cookies effortlessly:

// Add Custom Header
builder.Header().
    Add("header", "value")

// Add Multiple Custom Headers
builder.Header().
    AddAll(map[string]string{
        "key1": "value1",
        "key2": "value2",
        "key3": "value3",
    })

// Add Custom Cookie
builder.Cookie().
    Add(&http.Cookie{Name: "session_id", Value: "id"})

Advanced Configurations

Control every aspect of the HTTP client:

// Set Timeout
builder.Config().
    SetTimeout(time.Second * 30)

// Set Follow Redirect
builder.Config().
    SetFollowRedirects(false)

// Set Custom Transport
builder.Config().
    SetCustomTransport(myCustomTransport)

// Set Proxy
builder.Config().
    SetProxy("http://my-proxy-server:port")

Contributing 🤝

Your contributions are always welcome! Feel free to create pull requests, submit issues, or contribute in any other way.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BalancedBaseURL added in v0.9.0 

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

BalancedBaseURL implements ConfigBaseURL interface and provides load balancing.

func (*BalancedBaseURL) BaseURL added in v0.9.0 

func (c *BalancedBaseURL) BaseURL() *url.URL

BaseURL for BalancedBaseURL returns the next base URL in the list.

type BuilderAuth added in v0.9.0 

type BuilderAuth[T any] interface {
	Set(value string) *T
	BearerToken(token string) *T
	BasicAuth(username, password string) *T
}

BuilderAuth is the interface that wraps the basic methods for setting HTTP Authentication.

type BuilderCookie added in v0.9.0 

type BuilderCookie[T any] interface {
	Add(cookie *http.Cookie) *T
}

BuilderCookie is the interface that wraps the basic methods for setting HTTP Cookies.

type BuilderHeader added in v0.9.0 

type BuilderHeader[T any] interface {
	Add(key, value string) *T
	AddAll(headers map[string]string) *T
	Set(key, value string) *T
	SetAll(headers map[string]string) *T
	AddAccept(value string) *T
	AddContentType(value string) *T
	AddUserAgent(value string) *T
}

BuilderHeader is the interface that wraps the basic methods for setting custom HTTP BuilderHeader.

type BuilderHttpClientConfig added in v0.9.0 

type BuilderHttpClientConfig[T any] interface {
	SetCustomHttpClient(httpClient HttpClientComponent) *T
	SetCustomTransport(transport http.RoundTripper) *T
	SetTimeout(duration time.Duration) *T
	SetFollowRedirects(follow bool) *T
	SetProxy(proxyURL string) *T
}

BuilderHttpClientConfig is the interface that wraps the basic methods for setting HTTP ClientConfig configuration.

type BuilderRequestBody added in v0.9.0 

type BuilderRequestBody[T any] interface {
	AsReader(body io.Reader) *T
	AsString(body string) *T
	AsJSON(obj interface{}) *T
}

BuilderRequestBody is the interface that wraps the basic methods for setting HTTP BuilderRequestBody.

type BuilderRequestContext added in v0.9.0 

type BuilderRequestContext[T any] interface {
	Set(ctx context.Context) *T
}

BuilderRequestContext is the interface that wraps the basic methods for setting HTTP BuilderRequestContext.

type BuilderRequestQuery added in v0.9.0 

type BuilderRequestQuery[T any] interface {
	AddParam(param, value string) *T
	AddParams(params map[string]string) *T
	SetParam(param, value string) *T
	SetParams(params map[string]string) *T
	SetRawString(query string) *T
}

BuilderRequestQuery is the interface that wraps the basic methods for setting HTTP BuilderRequestQuery.

type BuilderRequestRetry added in v0.9.0 

type BuilderRequestRetry[T any] interface {
	Set(retries int, retryInterval time.Duration) *T
}

BuilderRequestRetry is the interface that wraps the basic methods for setting HTTP BuilderRequestRetry.

type Client 

type Client interface {
	ClientConfig
	ClientHttpMethods
}

type ClientAuthBuilder 

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

ClientAuthBuilder allows for setting authentication configurations.

func (*ClientAuthBuilder) BasicAuth 

func (b *ClientAuthBuilder) BasicAuth(username, password string) *ClientBuilder

BasicAuth sets the Authorization header for Basic authentication.

func (*ClientAuthBuilder) BearerToken 

func (b *ClientAuthBuilder) BearerToken(token string) *ClientBuilder

BearerToken sets the Authorization header for Bearer token authentication.

func (*ClientAuthBuilder) Set 

func (b *ClientAuthBuilder) Set(value string) *ClientBuilder

Set sets the Authorization header for custom authentication.

type ClientBuilder 

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

ClientBuilder serves as the main entry point for configuring HTTP clients.

func NewClient 

func NewClient(baseURL string) *ClientBuilder

NewClient initializes a new ClientBuilder with a given baseURL.

func NewClientLoadBalancer added in v0.9.0 

func NewClientLoadBalancer(baseURLs []string) *ClientBuilder

NewClientLoadBalancer initializes a new ClientBuilder with a given baseURLs.

func (*ClientBuilder) Auth 

func (b *ClientBuilder) Auth() *ClientAuthBuilder

Auth BuilderAuth returns a new ClientAuthBuilder for setting authentication options.

func (*ClientBuilder) Build 

func (b *ClientBuilder) Build() ClientHttpMethods

Build finalizes the ClientBuilder configurations and returns a new ClientConfig.

func (*ClientBuilder) Config 

func (b *ClientBuilder) Config() *ClientConfigBuilder

Config returns a new ClientConfigBuilder for setting custom client configurations.

func (*ClientBuilder) Cookie 

func (b *ClientBuilder) Cookie() *ClientCookieBuilder

BuilderCookie returns a new ClientCookieBuilder for setting custom HTTP Cookies.

func (*ClientBuilder) Header 

func (b *ClientBuilder) Header() *ClientHeaderBuilder

BuilderHeader returns a new ClientHeaderBuilder for setting custom HTTP BuilderHeader.

type ClientConfig added in v0.7.0 

type ClientConfig interface {
	ConfigHttpClient
	HttpHeader() *http.Header
	SetHttpCookie(cookie *http.Cookie)
	HttpCookies() []*http.Cookie
	SetValidation(validation error)
	Validations() []error
	ConfigBaseURL
}

type ClientConfigBase added in v0.9.0 

type ClientConfigBase struct {
	ConfigBaseURL
	// contains filtered or unexported fields
}

ClientConfigBase serves as the main entry point for configuring HTTP clients.

func (*ClientConfigBase) CONNECT added in v0.9.0 

func (c *ClientConfigBase) CONNECT(path string) *RequestBuilder

CONNECT is a shortcut for NewRequest(c, method.CONNECT, path).

func (*ClientConfigBase) DELETE added in v0.9.0 

func (c *ClientConfigBase) DELETE(path string) *RequestBuilder

DELETE is a shortcut for NewRequest(c, method.DELETE, path).

func (*ClientConfigBase) GET added in v0.9.0 

func (c *ClientConfigBase) GET(path string) *RequestBuilder

GET is a shortcut for NewRequest(c, method.GET, path).

func (*ClientConfigBase) HEAD added in v0.9.0 

func (c *ClientConfigBase) HEAD(path string) *RequestBuilder

HEAD is a shortcut for NewRequest(c, method.HEAD, path).

func (*ClientConfigBase) HttpClient added in v0.9.0 

func (c *ClientConfigBase) HttpClient() HttpClientComponent

HttpClient for ClientConfigBase returns the HTTP client.

func (*ClientConfigBase) HttpCookies added in v0.9.0 

func (c *ClientConfigBase) HttpCookies() []*http.Cookie

HttpCookies for ClientConfigBase returns the HTTP cookies.

func (*ClientConfigBase) HttpHeader added in v0.9.0 

func (c *ClientConfigBase) HttpHeader() *http.Header

HttpHeader for ClientConfigBase returns the HTTP header.

func (*ClientConfigBase) OPTIONS added in v0.9.0 

func (c *ClientConfigBase) OPTIONS(path string) *RequestBuilder

OPTIONS is a shortcut for NewRequest(c, method.OPTIONS, path).

func (*ClientConfigBase) PATCH added in v0.9.0 

func (c *ClientConfigBase) PATCH(path string) *RequestBuilder

PATCH is a shortcut for NewRequest(c, method.PATCH, path).

func (*ClientConfigBase) POST added in v0.9.0 

func (c *ClientConfigBase) POST(path string) *RequestBuilder

POST is a shortcut for NewRequest(c, method.POST, path).

func (*ClientConfigBase) PUT added in v0.9.0 

func (c *ClientConfigBase) PUT(path string) *RequestBuilder

PUT is a shortcut for NewRequest(c, method.PUT, path).

func (*ClientConfigBase) SetHttpClient added in v0.10.0 

func (c *ClientConfigBase) SetHttpClient(httpClient HttpClientComponent)

SetHttpClient for ClientConfigBase sets the HttpClientComponent.

func (*ClientConfigBase) SetHttpCookie added in v0.9.0 

func (c *ClientConfigBase) SetHttpCookie(cookie *http.Cookie)

SetHttpCookie for ClientConfigBase sets the HTTP cookie.

func (*ClientConfigBase) SetValidation added in v0.9.0 

func (c *ClientConfigBase) SetValidation(validations error)

SetValidation for ClientConfigBase sets the validation.

func (*ClientConfigBase) TRACE added in v0.9.0 

func (c *ClientConfigBase) TRACE(path string) *RequestBuilder

TRACE is a shortcut for NewRequest(c, method.TRACE, path).

func (*ClientConfigBase) Validations added in v0.9.0 

func (c *ClientConfigBase) Validations() []error

Validations for ClientConfigBase returns the validations.

type ClientConfigBuilder 

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

ClientConfigBuilder allows for setting other client configurations.

func (*ClientConfigBuilder) SetCustomHttpClient added in v0.10.0 

func (b *ClientConfigBuilder) SetCustomHttpClient(httpClient HttpClientComponent) *ClientBuilder

SetCustomHttpClient sets the underlying raw client

func (*ClientConfigBuilder) SetCustomTransport 

func (b *ClientConfigBuilder) SetCustomTransport(transport http.RoundTripper) *ClientBuilder

SetCustomTransport sets custom transport for the HTTP client.

func (*ClientConfigBuilder) SetFollowRedirects 

func (b *ClientConfigBuilder) SetFollowRedirects(follow bool) *ClientBuilder

SetFollowRedirects controls whether the HTTP client should follow redirects.

func (*ClientConfigBuilder) SetProxy added in v0.8.0 

func (b *ClientConfigBuilder) SetProxy(proxyURL string) *ClientBuilder

SetProxy sets the proxy URL for the HTTP client.

func (*ClientConfigBuilder) SetTimeout 

func (b *ClientConfigBuilder) SetTimeout(duration time.Duration) *ClientBuilder

SetTimeout sets the timeout for the HTTP client.

type ClientCookieBuilder 

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

ClientCookieBuilder allows for setting custom HTTP Cookies.

func (*ClientCookieBuilder) Add 

func (b *ClientCookieBuilder) Add(cookie *http.Cookie) *ClientBuilder

Add adds a custom cookie to the HTTP client.

type ClientHeaderBuilder 

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

ClientHeaderBuilder allows for setting custom HTTP BuilderHeader.

func (*ClientHeaderBuilder) Add 

func (b *ClientHeaderBuilder) Add(key, value string) *ClientBuilder

Add adds a custom header to the HTTP client. If header already exists, it will be appended.

func (*ClientHeaderBuilder) AddAccept 

func (b *ClientHeaderBuilder) AddAccept(value string) *ClientBuilder

AddAccept sets the Accept header. If header already exists, it will be appended.

func (*ClientHeaderBuilder) AddAll added in v0.6.0 

func (b *ClientHeaderBuilder) AddAll(headers map[string]string) *ClientBuilder

AddAll adds multiple custom headers to the HTTP client. If header already exists, it will be appended.

func (*ClientHeaderBuilder) AddContentType 

func (b *ClientHeaderBuilder) AddContentType(value string) *ClientBuilder

AddContentType sets the Content-Type header. If header already exists, it will be appended.

func (*ClientHeaderBuilder) AddUserAgent 

func (b *ClientHeaderBuilder) AddUserAgent(value string) *ClientBuilder

AddUserAgent sets the User-Agent header. If header already exists, it will be appended.

func (*ClientHeaderBuilder) Set 

func (b *ClientHeaderBuilder) Set(key, value string) *ClientBuilder

Set sets a custom header to the HTTP client. If header already exists, it will be overwritten.

func (*ClientHeaderBuilder) SetAll added in v0.6.0 

func (b *ClientHeaderBuilder) SetAll(headers map[string]string) *ClientBuilder

SetAll sets multiple custom headers to the HTTP client. If header already exists, it will be overwritten.

type ClientHttpMethods added in v0.9.0 

type ClientHttpMethods interface {
	GET(path string) *RequestBuilder
	POST(path string) *RequestBuilder
	PUT(path string) *RequestBuilder
	DELETE(path string) *RequestBuilder
	PATCH(path string) *RequestBuilder
	HEAD(path string) *RequestBuilder
	CONNECT(path string) *RequestBuilder
	OPTIONS(path string) *RequestBuilder
	TRACE(path string) *RequestBuilder
}

func DefaultClient 

func DefaultClient(baseURL string) ClientHttpMethods

DefaultClient initializes a new default ClientConfig with a given baseURL.

func DefaultClientLoadBalancer added in v0.9.0 

func DefaultClientLoadBalancer(baseURLs []string) ClientHttpMethods

DefaultClientLoadBalancer initializes a new default ClientConfig with a given baseURLs.

type ConfigBaseURL added in v0.9.0 

type ConfigBaseURL interface {
	BaseURL() *url.URL
}

type ConfigHttpClient added in v0.10.0 

type ConfigHttpClient interface {
	SetHttpClient(httpClient HttpClientComponent)
	HttpClient() HttpClientComponent
}

type DefaultBaseURL added in v0.9.0 

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

DefaultBaseURL implements ConfigBaseURL interface and provides a single base URL.

func (*DefaultBaseURL) BaseURL added in v0.9.0 

func (c *DefaultBaseURL) BaseURL() *url.URL

BaseURL for DefaultBaseURL returns the base URL.

type DefaultHttpClient added in v0.10.0 

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

DefaultHttpClient implements HttpClientComponent interface and provides a default HTTP client.

func (*DefaultHttpClient) Do added in v0.10.0 

func (c *DefaultHttpClient) Do(req *http.Request) (*http.Response, error)

Do will execute the *http.Client Do method

func (*DefaultHttpClient) SetCheckRedirect added in v0.10.0 

func (c *DefaultHttpClient) SetCheckRedirect(f func(*http.Request, []*http.Request) error)

SetCheckRedirect sets the CheckRedirect field on the underlying http.Client type

func (*DefaultHttpClient) SetTimeout added in v0.10.0 

func (c *DefaultHttpClient) SetTimeout(duration time.Duration)

SetTimeout sets the Timeout field on the underlying http.Client type

func (*DefaultHttpClient) SetTransport added in v0.10.0 

func (c *DefaultHttpClient) SetTransport(transport http.RoundTripper)

SetTransport sets the Transport field on the underlying http.Client type

func (*DefaultHttpClient) Timeout added in v0.10.0 

func (c *DefaultHttpClient) Timeout() time.Duration

Timeout will return the underlying timeout value

func (*DefaultHttpClient) Transport added in v0.10.0 

func (c *DefaultHttpClient) Transport() http.RoundTripper

Transport will return the underlying transport type

type HttpClientComponent added in v0.10.0 

type HttpClientComponent interface {
	Do(*http.Request) (*http.Response, error)
	SetTransport(http.RoundTripper)
	Transport() http.RoundTripper
	SetTimeout(time.Duration)
	Timeout() time.Duration
	SetCheckRedirect(func(*http.Request, []*http.Request) error)
}

type Request 

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

type RequestAuthBuilder added in v0.7.0 

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

RequestAuthBuilder allows for setting authentication configurations.

func (*RequestAuthBuilder) BasicAuth added in v0.7.0 

func (b *RequestAuthBuilder) BasicAuth(username, password string) *RequestBuilder

BasicAuth sets the Authorization header for Basic authentication.

func (*RequestAuthBuilder) BearerToken added in v0.7.0 

func (b *RequestAuthBuilder) BearerToken(token string) *RequestBuilder

BearerToken sets the Authorization header for Bearer token authentication.

func (*RequestAuthBuilder) Set added in v0.7.0 

func (b *RequestAuthBuilder) Set(value string) *RequestBuilder

Set sets the Authorization header for custom authentication.

type RequestBodyBuilder added in v0.6.0 

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

RequestBodyBuilder serves as the main entry point for configuring BuilderRequestBody.

func (*RequestBodyBuilder) AsJSON added in v0.6.0 

func (b *RequestBodyBuilder) AsJSON(obj interface{}) *RequestBuilder

AsJSON sets the body as JSON.

func (*RequestBodyBuilder) AsReader added in v0.6.0 

func (b *RequestBodyBuilder) AsReader(body io.Reader) *RequestBuilder

AsReader sets the body as IO Reader.

func (*RequestBodyBuilder) AsString added in v0.6.0 

func (b *RequestBodyBuilder) AsString(body string) *RequestBuilder

AsString sets the body as string.

type RequestBuilder added in v0.6.0 

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

func (*RequestBuilder) Auth added in v0.7.0 

func (b *RequestBuilder) Auth() *RequestAuthBuilder

BuilderAuth returns a new ClientAuthBuilder for setting authentication options.

func (*RequestBuilder) Body added in v0.6.0 

func (b *RequestBuilder) Body() *RequestBodyBuilder

Body returns a new RequestBodyBuilder for setting custom HTTP Body's.

func (*RequestBuilder) Context added in v0.6.0 

func (b *RequestBuilder) Context() *RequestContextBuilder

Context returns a new RequestContextBuilder for setting custom Context.

func (*RequestBuilder) Cookie added in v0.6.0 

func (b *RequestBuilder) Cookie() *RequestCookieBuilder

BuilderCookie returns a new RequestCookieBuilder for setting custom HTTP Cookies.

func (*RequestBuilder) Header added in v0.6.0 

func (b *RequestBuilder) Header() *RequestHeaderBuilder

BuilderHeader returns a new RequestHeaderBuilder for setting custom HTTP BuilderHeader.

func (*RequestBuilder) Query added in v0.6.0 

func (b *RequestBuilder) Query() *RequestQueryBuilder

Query returns a new RequestQueryBuilder for setting query parameters.

func (*RequestBuilder) Retry added in v0.6.0 

func (b *RequestBuilder) Retry() *RequestRetryBuilder

Retry returns a new RequestRetryBuilder for setting custom HTTP Cookies.

func (*RequestBuilder) Send added in v0.6.0 

func (b *RequestBuilder) Send() (Response, error)

type RequestContextBuilder added in v0.6.0 

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

RequestContextBuilder serves as the main entry point for configuring Request Context.

func (*RequestContextBuilder) Set added in v0.6.0 

func (b *RequestContextBuilder) Set(ctx context.Context) *RequestBuilder

Set sets the Context.

type RequestCookieBuilder added in v0.6.0 

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

RequestCookieBuilder serves as the main entry point for configuring HTTP Cookies.

func (*RequestCookieBuilder) Add added in v0.6.0 

func (b *RequestCookieBuilder) Add(cookie *http.Cookie) *RequestBuilder

Add adds a custom cookie to the HTTP client.

type RequestHeaderBuilder added in v0.6.0 

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

RequestHeaderBuilder is a builder for setting custom HTTP BuilderHeader.

func (*RequestHeaderBuilder) Add added in v0.6.0 

func (b *RequestHeaderBuilder) Add(key, value string) *RequestBuilder

Add adds a custom header to the HTTP request. If header already exists, it will be appended.

func (*RequestHeaderBuilder) AddAccept added in v0.6.0 

func (b *RequestHeaderBuilder) AddAccept(value string) *RequestBuilder

AddAccept sets the Accept header. If header already exists, it will be appended.

func (*RequestHeaderBuilder) AddAll added in v0.6.0 

func (b *RequestHeaderBuilder) AddAll(headers map[string]string) *RequestBuilder

AddAll adds custom headers to the HTTP request. If header already exists, it will be appended.

func (*RequestHeaderBuilder) AddContentType added in v0.6.0 

func (b *RequestHeaderBuilder) AddContentType(value string) *RequestBuilder

AddContentType sets the Content-Type header. If header already exists, it will be appended.

func (*RequestHeaderBuilder) AddUserAgent added in v0.6.0 

func (b *RequestHeaderBuilder) AddUserAgent(value string) *RequestBuilder

AddUserAgent sets the User-Agent header. If header already exists, it will be appended.

func (*RequestHeaderBuilder) Set added in v0.6.0 

func (b *RequestHeaderBuilder) Set(key, value string) *RequestBuilder

Set sets a custom header to the HTTP request. If header already exists, it will be overwritten.

func (*RequestHeaderBuilder) SetAll added in v0.6.0 

func (b *RequestHeaderBuilder) SetAll(headers map[string]string) *RequestBuilder

SetAll sets custom headers to the HTTP request. If header already exists, it will be overwritten.

type RequestQueryBuilder added in v0.6.0 

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

RequestQueryBuilder serves as the main entry point for configuring BuilderRequestQuery.

func (*RequestQueryBuilder) AddParam added in v0.6.0 

func (b *RequestQueryBuilder) AddParam(param, value string) *RequestBuilder

AddParam adds a query parameter to the HTTP request. If parameter already exists, it will be appended.

func (*RequestQueryBuilder) AddParams added in v0.6.0 

func (b *RequestQueryBuilder) AddParams(params map[string]string) *RequestBuilder

AddParams adds multiple query parameters to the HTTP request. If parameter already exists, it will be appended.

func (*RequestQueryBuilder) SetParam added in v0.6.0 

func (b *RequestQueryBuilder) SetParam(param, value string) *RequestBuilder

SetParam sets a query parameter to the HTTP request. If parameter already exists, it will be overwritten.

func (*RequestQueryBuilder) SetParams added in v0.6.0 

func (b *RequestQueryBuilder) SetParams(params map[string]string) *RequestBuilder

SetParams sets multiple query parameters to the HTTP request. If parameter already exists, it will be overwritten.

func (*RequestQueryBuilder) SetRawString added in v0.6.0 

func (b *RequestQueryBuilder) SetRawString(query string) *RequestBuilder

SetRawString sets query parameters from a raw query string.

type RequestRetryBuilder added in v0.6.0 

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

RequestRetryBuilder serves as the main entry point for configuring Request retries.

func (*RequestRetryBuilder) Set added in v0.6.0 

func (b *RequestRetryBuilder) Set(retries int, retryInterval time.Duration) *RequestBuilder

Set sets the number of retries and the retry interval.

type Response 

type Response struct {
	Request     *Request
	RawResponse *http.Response
}

func (*Response) Is1xxInformational 

func (r *Response) Is1xxInformational() bool

func (*Response) Is2xxSuccessful 

func (r *Response) Is2xxSuccessful() bool

func (*Response) Is3xxRedirection 

func (r *Response) Is3xxRedirection() bool

func (*Response) Is4xxClientError 

func (r *Response) Is4xxClientError() bool

func (*Response) Is5xxServerError 

func (r *Response) Is5xxServerError() bool

func (*Response) IsError 

func (r *Response) IsError() bool

func (*Response) RawBody 

func (r *Response) RawBody() io.ReadCloser

func (*Response) Status 

func (r *Response) Status() string

func (*Response) StatusCode 

func (r *Response) StatusCode() int

func (*Response) StatusText added in v0.8.3 

func (r *Response) StatusText() string

Source Files

View all Source files

Directories

Path Synopsis
header
method
mime

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.