| id | title | description | sidebar_position | toc_max_heading_level |
|---|---|---|---|---|
rest |
🖥️ REST |
HTTP client for Gofiber. |
1 |
5 |
The Fiber Client for Fiber v3 is a powerful HTTP client optimized for high performance and ease of use in server-side applications. Built atop the FastHTTP library, it inherits FastHTTP's high-speed HTTP protocol implementation. The client is designed for making both internal requests (within a microservices architecture) and external requests to other web services.
- Lightweight & Fast: Due to its FastHTTP foundation, the Fiber Client is both lightweight and extremely performant.
- Flexible Configuration: Set client-level configurations (e.g., timeouts, headers) that apply to all requests, while still allowing overrides at the individual request level.
- Connection Pooling: Maintains a pool of persistent connections, minimizing the overhead of establishing new connections for each request.
- Timeouts & Retries: Supports request-level timeouts and configurable retries to handle transient errors gracefully.
Instantiate the Fiber Client with your desired configurations, then send requests:
package main
import (
"fmt"
"time"
"github.com/gofiber/fiber/v3/client"
)
func main() {
cc := client.New()
cc.SetTimeout(10 * time.Second)
// Send a GET request
resp, err := cc.Get("https://httpbin.org/get")
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", resp.StatusCode())
fmt.Printf("Body: %s\n", string(resp.Body()))
}Check out examples for more detailed usage examples.
type Client struct {
mu sync.RWMutex
fasthttp *fasthttp.Client
baseURL string
userAgent string
referer string
header *Header
params *QueryParam
cookies *Cookie
path *PathParam
debug bool
timeout time.Duration
// user-defined request hooks
userRequestHooks []RequestHook
// client package-defined request hooks
builtinRequestHooks []RequestHook
// user-defined response hooks
userResponseHooks []ResponseHook
// client package-defined response hooks
builtinResponseHooks []ResponseHook
jsonMarshal utils.JSONMarshal
jsonUnmarshal utils.JSONUnmarshal
xmlMarshal utils.XMLMarshal
xmlUnmarshal utils.XMLUnmarshal
cborMarshal utils.CBORMarshal
cborUnmarshal utils.CBORUnmarshal
cookieJar *CookieJar
// proxy
proxyURL string
// retry
retryConfig *RetryConfig
// logger
logger log.CommonLogger
}New creates and returns a new Client object.
func New() *ClientNewWithClient creates and returns a new Client object from an existing fasthttp.Client.
func NewWithClient(c *fasthttp.Client) *ClientThe following methods send HTTP requests using the configured client:
Sends a GET request, similar to axios.
func (c *Client) Get(url string, cfg ...Config) (*Response, error)Sends a POST request, similar to axios.
func (c *Client) Post(url string, cfg ...Config) (*Response, error)Sends a PUT request, similar to axios.
func (c *Client) Put(url string, cfg ...Config) (*Response, error)Sends a PATCH request, similar to axios.
func (c *Client) Patch(url string, cfg ...Config) (*Response, error)Sends a DELETE request, similar to axios.
func (c *Client) Delete(url string, cfg ...Config) (*Response, error)Sends a HEAD request, similar to axios.
func (c *Client) Head(url string, cfg ...Config) (*Response, error)Sends an OPTIONS request, similar to axios.
func (c *Client) Options(url string, cfg ...Config) (*Response, error)Sends a custom HTTP request, similar to axios, allowing you to specify any method.
func (c *Client) Custom(url, method string, cfg ...Config) (*Response, error)The Config type helps configure request parameters. When setting the request body, JSON is used as the default serialization. The priority of the body sources is:
- Body
- FormData
- File
type Config struct {
Ctx context.Context
UserAgent string
Referer string
Header map[string]string
Param map[string]string
Cookie map[string]string
PathParam map[string]string
Timeout time.Duration
MaxRedirects int
Body any
FormData map[string]string
File []*File
}R creates a new Request object from the client's request pool. Use ReleaseRequest() to return it to the pool when done.
func (c *Client) R() *RequestHooks allow you to add custom logic before a request is sent or after a response is received.
RequestHook returns user-defined request hooks.
func (c *Client) RequestHook() []RequestHookResponseHook returns user-defined response hooks.
func (c *Client) ResponseHook() []ResponseHookAdds one or more user-defined request hooks.
func (c *Client) AddRequestHook(h ...RequestHook) *ClientAdds one or more user-defined response hooks.
func (c *Client) AddResponseHook(h ...ResponseHook) *ClientReturns the JSON marshaler function used by the client.
func (c *Client) JSONMarshal() utils.JSONMarshalReturns the JSON unmarshaller function used by the client.
func (c *Client) JSONUnmarshal() utils.JSONUnmarshalSets a custom JSON marshaler.
func (c *Client) SetJSONMarshal(f utils.JSONMarshal) *ClientSets a custom JSON unmarshaller.
func (c *Client) SetJSONUnmarshal(f utils.JSONUnmarshal) *ClientReturns the XML marshaler function used by the client.
func (c *Client) XMLMarshal() utils.XMLMarshalReturns the XML unmarshaller function used by the client.
func (c *Client) XMLUnmarshal() utils.XMLUnmarshalSets a custom XML marshaler.
func (c *Client) SetXMLMarshal(f utils.XMLMarshal) *ClientSets a custom XML unmarshaller.
func (c *Client) SetXMLUnmarshal(f utils.XMLUnmarshal) *ClientReturns the CBOR marshaler function used by the client.
func (c *Client) CBORMarshal() utils.CBORMarshalReturns the CBOR unmarshaller function used by the client.
func (c *Client) CBORUnmarshal() utils.CBORUnmarshalSets a custom CBOR marshaler.
func (c *Client) SetCBORMarshal(f utils.CBORMarshal) *ClientSets a custom CBOR unmarshaller.
func (c *Client) SetCBORUnmarshal(f utils.CBORUnmarshal) *ClientReturns the client's TLS configuration. If none is set, it initializes a new one.
func (c *Client) TLSConfig() *tls.ConfigSets the TLS configuration for the client.
func (c *Client) SetTLSConfig(config *tls.Config) *ClientAdds client certificates to the TLS configuration.
func (c *Client) SetCertificates(certs ...tls.Certificate) *ClientAdds one or more root certificates to the client's trust store.
func (c *Client) SetRootCertificate(path string) *ClientAdds one or more root certificates from a string.
func (c *Client) SetRootCertificateFromString(pem string) *ClientSets a proxy URL for the client. All subsequent requests will use this proxy.
func (c *Client) SetProxyURL(proxyURL string) errorReturns the retry configuration of the client.
func (c *Client) RetryConfig() *RetryConfigSets the retry configuration for the client.
func (c *Client) SetRetryConfig(config *RetryConfig) *ClientBaseURL returns the base URL currently set in the client.
func (c *Client) BaseURL() stringSets a base URL prefix for all requests made by the client.
func (c *Client) SetBaseURL(url string) *ClientExample:
cc := client.New()
cc.SetBaseURL("https://httpbin.org/")
resp, err := cc.Get("/get")
if err != nil {
panic(err)
}
fmt.Println(string(resp.Body()))Click here to see the result
{
"args": {},
...
}Retrieves all values of a header key at the client level. The returned values apply to all requests.
func (c *Client) Header(key string) []stringAdds a single header to all requests initiated by this client.
func (c *Client) AddHeader(key, val string) *ClientSets a single header, overriding any existing headers with the same key.
func (c *Client) SetHeader(key, val string) *ClientAdds multiple headers at once, all applying to all future requests from this client.
func (c *Client) AddHeaders(h map[string][]string) *ClientSets multiple headers at once, overriding previously set headers.
func (c *Client) SetHeaders(h map[string]string) *ClientReturns the values for a given query parameter key.
func (c *Client) Param(key string) []stringAdds a single query parameter for all requests.
func (c *Client) AddParam(key, val string) *ClientSets a single query parameter, overriding previously set values.
func (c *Client) SetParam(key, val string) *ClientAdds multiple query parameters from a map of string slices.
func (c *Client) AddParams(m map[string][]string) *ClientSets multiple query parameters from a map, overriding previously set values.
func (c *Client) SetParams(m map[string]string) *ClientSets multiple query parameters from a struct. Nested structs are not currently supported.
func (c *Client) SetParamsWithStruct(v any) *ClientDeletes one or more query parameters.
func (c *Client) DelParams(key ...string) *ClientSets the user agent header for all requests.
func (c *Client) SetUserAgent(ua string) *ClientSets the referer header for all requests.
func (c *Client) SetReferer(r string) *ClientReturns the value of a named path parameter, if set.
func (c *Client) PathParam(key string) stringSets a single path parameter.
func (c *Client) SetPathParam(key, val string) *ClientSets multiple path parameters at once.
func (c *Client) SetPathParams(m map[string]string) *ClientSets multiple path parameters from a struct.
func (c *Client) SetPathParamsWithStruct(v any) *ClientDeletes one or more path parameters.
func (c *Client) DelPathParams(key ...string) *ClientReturns the value of a named cookie if set at the client level.
func (c *Client) Cookie(key string) stringSets a single cookie for all requests.
func (c *Client) SetCookie(key, val string) *ClientExample:
cc := client.New()
cc.SetCookie("john", "doe")
resp, err := cc.Get("https://httpbin.org/cookies")
if err != nil {
panic(err)
}
fmt.Println(string(resp.Body()))Click here to see the result
{
"cookies": {
"john": "doe"
}
}Sets multiple cookies at once.
func (c *Client) SetCookies(m map[string]string) *ClientSets multiple cookies from a struct.
func (c *Client) SetCookiesWithStruct(v any) *ClientDeletes one or more cookies.
func (c *Client) DelCookies(key ...string) *ClientSets a default timeout for all requests, which can be overridden per request.
func (c *Client) SetTimeout(t time.Duration) *ClientEnables debug-level logging output.
func (c *Client) Debug() *ClientDisables debug-level logging output.
func (c *Client) DisableDebug() *ClientAssigns a cookie jar to the client to store and manage cookies across requests.
func (c *Client) SetCookieJar(cookieJar *CookieJar) *ClientSets a custom dial function.
func (c *Client) SetDial(dial fasthttp.DialFunc) *ClientSets the logger instance used by the client.
func (c *Client) SetLogger(logger log.CommonLogger) *ClientReturns the current logger instance.
func (c *Client) Logger() log.CommonLoggerClears and resets the client to its default state.
func (c *Client) Reset()Fiber provides a default client (created with New()). You can configure it or replace it as needed.
C returns the default client.
func C() *ClientGet is a convenience method that sends a GET request using the defaultClient.
func Get(url string, cfg ...Config) (*Response, error)Post is a convenience method that sends a POST request using the defaultClient.
func Post(url string, cfg ...Config) (*Response, error)Put is a convenience method that sends a PUT request using the defaultClient.
func Put(url string, cfg ...Config) (*Response, error)Patch is a convenience method that sends a PATCH request using the defaultClient.
func Patch(url string, cfg ...Config) (*Response, error)Delete is a convenience method that sends a DELETE request using the defaultClient.
func Delete(url string, cfg ...Config) (*Response, error)Head sends a HEAD request using the defaultClient, a convenience method.
func Head(url string, cfg ...Config) (*Response, error)Options is a convenience method that sends an OPTIONS request using the defaultClient.
func Options(url string, cfg ...Config) (*Response, error)Replace replaces the default client with a new one. It returns a function that can restore the old client.
:::caution Do not modify the default client concurrently. :::
func Replace(c *Client) func()