---
id: rest
title: 🖥️ REST
description: >-
HTTP client for Gofiber.
sidebar_position: 1
toc_max_heading_level: 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.
## Features
- **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.
## Usage
Instantiate the Fiber Client with your desired configurations, then send requests:
```go
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](examples.md) for more detailed usage examples.
```go
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
**New** creates and returns a new Client object.
```go title="Signature"
func New() *Client
```
### NewWithClient
**NewWithClient** creates and returns a new Client object from an existing `fasthttp.Client`.
```go title="Signature"
func NewWithClient(c *fasthttp.Client) *Client
```
## REST Methods
The following methods send HTTP requests using the configured client:
### Get
Sends a GET request, similar to axios.
```go title="Signature"
func (c *Client) Get(url string, cfg ...Config) (*Response, error)
```
### Post
Sends a POST request, similar to axios.
```go title="Signature"
func (c *Client) Post(url string, cfg ...Config) (*Response, error)
```
### Put
Sends a PUT request, similar to axios.
```go title="Signature"
func (c *Client) Put(url string, cfg ...Config) (*Response, error)
```
### Patch
Sends a PATCH request, similar to axios.
```go title="Signature"
func (c *Client) Patch(url string, cfg ...Config) (*Response, error)
```
### Delete
Sends a DELETE request, similar to axios.
```go title="Signature"
func (c *Client) Delete(url string, cfg ...Config) (*Response, error)
```
### Head
Sends a HEAD request, similar to axios.
```go title="Signature"
func (c *Client) Head(url string, cfg ...Config) (*Response, error)
```
### Options
Sends an OPTIONS request, similar to axios.
```go title="Signature"
func (c *Client) Options(url string, cfg ...Config) (*Response, error)
```
### Custom
Sends a custom HTTP request, similar to axios, allowing you to specify any method.
```go title="Signature"
func (c *Client) Custom(url, method string, cfg ...Config) (*Response, error)
```
## Request Configuration
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:
1. Body
2. FormData
3. File
```go
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
**R** creates a new `Request` object from the client's request pool. Use `ReleaseRequest()` to return it to the pool when done.
```go title="Signature"
func (c *Client) R() *Request
```
## Hooks
Hooks allow you to add custom logic before a request is sent or after a response is received.
### RequestHook
**RequestHook** returns user-defined request hooks.
```go title="Signature"
func (c *Client) RequestHook() []RequestHook
```
### ResponseHook
**ResponseHook** returns user-defined response hooks.
```go title="Signature"
func (c *Client) ResponseHook() []ResponseHook
```
### AddRequestHook
Adds one or more user-defined request hooks.
```go title="Signature"
func (c *Client) AddRequestHook(h ...RequestHook) *Client
```
### AddResponseHook
Adds one or more user-defined response hooks.
```go title="Signature"
func (c *Client) AddResponseHook(h ...ResponseHook) *Client
```
## JSON
### JSONMarshal
Returns the JSON marshaler function used by the client.
```go title="Signature"
func (c *Client) JSONMarshal() utils.JSONMarshal
```
### JSONUnmarshal
Returns the JSON unmarshaller function used by the client.
```go title="Signature"
func (c *Client) JSONUnmarshal() utils.JSONUnmarshal
```
### SetJSONMarshal
Sets a custom JSON marshaler.
```go title="Signature"
func (c *Client) SetJSONMarshal(f utils.JSONMarshal) *Client
```
### SetJSONUnmarshal
Sets a custom JSON unmarshaller.
```go title="Signature"
func (c *Client) SetJSONUnmarshal(f utils.JSONUnmarshal) *Client
```
## XML
### XMLMarshal
Returns the XML marshaler function used by the client.
```go title="Signature"
func (c *Client) XMLMarshal() utils.XMLMarshal
```
### XMLUnmarshal
Returns the XML unmarshaller function used by the client.
```go title="Signature"
func (c *Client) XMLUnmarshal() utils.XMLUnmarshal
```
### SetXMLMarshal
Sets a custom XML marshaler.
```go title="Signature"
func (c *Client) SetXMLMarshal(f utils.XMLMarshal) *Client
```
### SetXMLUnmarshal
Sets a custom XML unmarshaller.
```go title="Signature"
func (c *Client) SetXMLUnmarshal(f utils.XMLUnmarshal) *Client
```
## CBOR
### CBORMarshal
Returns the CBOR marshaler function used by the client.
```go title="Signature"
func (c *Client) CBORMarshal() utils.CBORMarshal
```
### CBORUnmarshal
Returns the CBOR unmarshaller function used by the client.
```go title="Signature"
func (c *Client) CBORUnmarshal() utils.CBORUnmarshal
```
### SetCBORMarshal
Sets a custom CBOR marshaler.
```go title="Signature"
func (c *Client) SetCBORMarshal(f utils.CBORMarshal) *Client
```
### SetCBORUnmarshal
Sets a custom CBOR unmarshaller.
```go title="Signature"
func (c *Client) SetCBORUnmarshal(f utils.CBORUnmarshal) *Client
```
## TLS
### TLSConfig
Returns the client's TLS configuration. If none is set, it initializes a new one.
```go title="Signature"
func (c *Client) TLSConfig() *tls.Config
```
### SetTLSConfig
Sets the TLS configuration for the client.
```go title="Signature"
func (c *Client) SetTLSConfig(config *tls.Config) *Client
```
### SetCertificates
Adds client certificates to the TLS configuration.
```go title="Signature"
func (c *Client) SetCertificates(certs ...tls.Certificate) *Client
```
### SetRootCertificate
Adds one or more root certificates to the client's trust store.
```go title="Signature"
func (c *Client) SetRootCertificate(path string) *Client
```
### SetRootCertificateFromString
Adds one or more root certificates from a string.
```go title="Signature"
func (c *Client) SetRootCertificateFromString(pem string) *Client
```
## SetProxyURL
Sets a proxy URL for the client. All subsequent requests will use this proxy.
```go title="Signature"
func (c *Client) SetProxyURL(proxyURL string) error
```
## RetryConfig
Returns the retry configuration of the client.
```go title="Signature"
func (c *Client) RetryConfig() *RetryConfig
```
## SetRetryConfig
Sets the retry configuration for the client.
```go title="Signature"
func (c *Client) SetRetryConfig(config *RetryConfig) *Client
```
## BaseURL
### BaseURL
**BaseURL** returns the base URL currently set in the client.
```go title="Signature"
func (c *Client) BaseURL() string
```
### SetBaseURL
Sets a base URL prefix for all requests made by the client.
```go title="Signature"
func (c *Client) SetBaseURL(url string) *Client
```
**Example:**
```go title="Example"
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
```json
{
"args": {},
...
}
```
## Headers
### Header
Retrieves all values of a header key at the client level. The returned values apply to all requests.
```go title="Signature"
func (c *Client) Header(key string) []string
```
### AddHeader
Adds a single header to all requests initiated by this client.
```go title="Signature"
func (c *Client) AddHeader(key, val string) *Client
```
### SetHeader
Sets a single header, overriding any existing headers with the same key.
```go title="Signature"
func (c *Client) SetHeader(key, val string) *Client
```
### AddHeaders
Adds multiple headers at once, all applying to all future requests from this client.
```go title="Signature"
func (c *Client) AddHeaders(h map[string][]string) *Client
```
### SetHeaders
Sets multiple headers at once, overriding previously set headers.
```go title="Signature"
func (c *Client) SetHeaders(h map[string]string) *Client
```
## Query Parameters
### Param
Returns the values for a given query parameter key.
```go title="Signature"
func (c *Client) Param(key string) []string
```
### AddParam
Adds a single query parameter for all requests.
```go title="Signature"
func (c *Client) AddParam(key, val string) *Client
```
### SetParam
Sets a single query parameter, overriding previously set values.
```go title="Signature"
func (c *Client) SetParam(key, val string) *Client
```
### AddParams
Adds multiple query parameters from a map of string slices.
```go title="Signature"
func (c *Client) AddParams(m map[string][]string) *Client
```
### SetParams
Sets multiple query parameters from a map, overriding previously set values.
```go title="Signature"
func (c *Client) SetParams(m map[string]string) *Client
```
### SetParamsWithStruct
Sets multiple query parameters from a struct. Nested structs are not currently supported.
```go title="Signature"
func (c *Client) SetParamsWithStruct(v any) *Client
```
### DelParams
Deletes one or more query parameters.
```go title="Signature"
func (c *Client) DelParams(key ...string) *Client
```
## UserAgent & Referer
### SetUserAgent
Sets the user agent header for all requests.
```go title="Signature"
func (c *Client) SetUserAgent(ua string) *Client
```
### SetReferer
Sets the referer header for all requests.
```go title="Signature"
func (c *Client) SetReferer(r string) *Client
```
## Path Parameters
### PathParam
Returns the value of a named path parameter, if set.
```go title="Signature"
func (c *Client) PathParam(key string) string
```
### SetPathParam
Sets a single path parameter.
```go title="Signature"
func (c *Client) SetPathParam(key, val string) *Client
```
### SetPathParams
Sets multiple path parameters at once.
```go title="Signature"
func (c *Client) SetPathParams(m map[string]string) *Client
```
### SetPathParamsWithStruct
Sets multiple path parameters from a struct.
```go title="Signature"
func (c *Client) SetPathParamsWithStruct(v any) *Client
```
### DelPathParams
Deletes one or more path parameters.
```go title="Signature"
func (c *Client) DelPathParams(key ...string) *Client
```
## Cookies
### Cookie
Returns the value of a named cookie if set at the client level.
```go title="Signature"
func (c *Client) Cookie(key string) string
```
### SetCookie
Sets a single cookie for all requests.
```go title="Signature"
func (c *Client) SetCookie(key, val string) *Client
```
**Example:**
```go title="Example"
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
```json
{
"cookies": {
"john": "doe"
}
}
```
### SetCookies
Sets multiple cookies at once.
```go title="Signature"
func (c *Client) SetCookies(m map[string]string) *Client
```
### SetCookiesWithStruct
Sets multiple cookies from a struct.
```go title="Signature"
func (c *Client) SetCookiesWithStruct(v any) *Client
```
### DelCookies
Deletes one or more cookies.
```go title="Signature"
func (c *Client) DelCookies(key ...string) *Client
```
## Timeout
### SetTimeout
Sets a default timeout for all requests, which can be overridden per request.
```go title="Signature"
func (c *Client) SetTimeout(t time.Duration) *Client
```
## Debugging
### Debug
Enables debug-level logging output.
```go title="Signature"
func (c *Client) Debug() *Client
```
### DisableDebug
Disables debug-level logging output.
```go title="Signature"
func (c *Client) DisableDebug() *Client
```
## Cookie Jar
### SetCookieJar
Assigns a cookie jar to the client to store and manage cookies across requests.
```go title="Signature"
func (c *Client) SetCookieJar(cookieJar *CookieJar) *Client
```
## Dial & Logger
### SetDial
Sets a custom dial function.
```go title="Signature"
func (c *Client) SetDial(dial fasthttp.DialFunc) *Client
```
### SetLogger
Sets the logger instance used by the client.
```go title="Signature"
func (c *Client) SetLogger(logger log.CommonLogger) *Client
```
### Logger
Returns the current logger instance.
```go title="Signature"
func (c *Client) Logger() log.CommonLogger
```
## Reset
### Reset
Clears and resets the client to its default state.
```go title="Signature"
func (c *Client) Reset()
```
## Default Client
Fiber provides a default client (created with `New()`). You can configure it or replace it as needed.
### C
**C** returns the default client.
```go title="Signature"
func C() *Client
```
### Get
Get is a convenience method that sends a GET request using the `defaultClient`.
```go title="Signature"
func Get(url string, cfg ...Config) (*Response, error)
```
### Post
Post is a convenience method that sends a POST request using the `defaultClient`.
```go title="Signature"
func Post(url string, cfg ...Config) (*Response, error)
```
### Put
Put is a convenience method that sends a PUT request using the `defaultClient`.
```go title="Signature"
func Put(url string, cfg ...Config) (*Response, error)
```
### Patch
Patch is a convenience method that sends a PATCH request using the `defaultClient`.
```go title="Signature"
func Patch(url string, cfg ...Config) (*Response, error)
```
### Delete
Delete is a convenience method that sends a DELETE request using the `defaultClient`.
```go title="Signature"
func Delete(url string, cfg ...Config) (*Response, error)
```
### Head
Head sends a HEAD request using the `defaultClient`, a convenience method.
```go title="Signature"
func Head(url string, cfg ...Config) (*Response, error)
```
### Options
Options is a convenience method that sends an OPTIONS request using the `defaultClient`.
```go title="Signature"
func Options(url string, cfg ...Config) (*Response, error)
```
### Replace
**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.
:::
```go title="Signature"
func Replace(c *Client) func()
```