Cache

Cache middleware for Fiber that intercepts responses and stores the body, Content-Type, and status code under a key derived from the request path and method. Special thanks to @codemicro for contributing this middleware to Fiber core.

Request directives

• Cache-Control: no-cache returns the latest response while still caching it, so the status is always miss.
• Cache-Control: no-store skips caching and always forwards a fresh response.

If the response includes a Cache-Control: max-age directive, its value sets the cache entry's expiration.

Cacheable status codes

The middleware caches these RFC 7231 status codes:

• 200: OK
• 203: Non-Authoritative Information
• 204: No Content
• 206: Partial Content
• 300: Multiple Choices
• 301: Moved Permanently
• 404: Not Found
• 405: Method Not Allowed
• 410: Gone
• 414: URI Too Long
• 501: Not Implemented

Responses with other status codes result in an unreachable cache status.

For more about cacheable status codes and RFC 7231, see:

• Cacheable - MDN Web Docs

• RFC7231 - Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content

Signatures

func New(config ...Config) fiber.Handler

Examples

Import the middleware package:

import (
    "github.com/gofiber/fiber/v3"
    "github.com/gofiber/fiber/v3/middleware/cache"
    "github.com/gofiber/utils/v2"
)

Once your Fiber app is initialized, register the middleware:

// Initialize default config
app.Use(cache.New())

// Or extend the config for customization
app.Use(cache.New(cache.Config{
    Next: func(c fiber.Ctx) bool {
        return fiber.Query[bool](c, "noCache")
    },
    Expiration: 30 * time.Minute,
    CacheControl: true,
}))

Customize the cache key and expiration; the HTTP method is appended automatically:

app.Use(cache.New(cache.Config{
    ExpirationGenerator: func(c fiber.Ctx, cfg *cache.Config) time.Duration {
        newCacheTime, _ := strconv.Atoi(c.GetRespHeader("Cache-Time", "600"))
        return time.Second * time.Duration(newCacheTime)
    },
    KeyGenerator: func(c fiber.Ctx) string {
        return utils.CopyString(c.Path())
    },
}))

app.Get("/", func(c fiber.Ctx) error {
    c.Response().Header.Add("Cache-Time", "6000")
    return c.SendString("hi")
})

Use CacheInvalidator to invalidate entries programmatically:

app.Use(cache.New(cache.Config{
    CacheInvalidator: func(c fiber.Ctx) bool {
        return fiber.Query[bool](c, "invalidateCache")
    },
}))

CacheInvalidator defines custom invalidation rules. Return true to bypass the cache. In the example above, setting the invalidateCache query parameter to true invalidates the entry.

Config

Property	Type	Description	Default
Next	func(fiber.Ctx) bool	Next defines a function that is executed before creating the cache entry and can be used to execute the request without cache creation. If an entry already exists, it will be used. If you want to completely bypass the cache functionality in certain cases, you should use the skip middleware.	nil
Expiration	time.Duration	Expiration is the time that a cached response will live.	1 * time.Minute
CacheHeader	string	CacheHeader is the header on the response header that indicates the cache status, with the possible return values "hit," "miss," or "unreachable."	X-Cache
CacheControl	bool	CacheControl enables client-side caching if set to true.	false
CacheInvalidator	func(fiber.Ctx) bool	CacheInvalidator defines a function that is executed before checking the cache entry. It can be used to invalidate the existing cache manually by returning true.	nil
KeyGenerator	func(fiber.Ctx) string	Key allows you to generate custom keys. The HTTP method is appended automatically.	func(c fiber.Ctx) string { return utils.CopyString(c.Path()) }
ExpirationGenerator	func(fiber.Ctx, *cache.Config) time.Duration	ExpirationGenerator allows you to generate custom expiration keys based on the request.	nil
Storage	fiber.Storage	Storage is used to store the state of the middleware.	In-memory store
StoreResponseHeaders	bool	StoreResponseHeaders allows you to store additional headers generated by next middlewares & handler.	false
MaxBytes	uint	MaxBytes is the maximum number of bytes of response bodies simultaneously stored in cache.	0 (No limit)
Methods	[]string	Methods specifies the HTTP methods to cache.	[]string{fiber.MethodGet, fiber.MethodHead}

Default Config

var ConfigDefault = Config{
    Next:         nil,
    Expiration:   1 * time.Minute,
    CacheHeader:  "X-Cache",
    CacheControl: false,
    CacheInvalidator: nil,
    KeyGenerator: func(c fiber.Ctx) string {
        return utils.CopyString(c.Path())
    },
    ExpirationGenerator:  nil,
    StoreResponseHeaders: false,
    Storage:              nil,
    MaxBytes:             0,
    Methods: []string{fiber.MethodGet, fiber.MethodHead},
}