Compress

Compression middleware for Fiber that supports gzip, deflate and brotli compression depending on the Accept-Encoding header.

Getting Started

Import the compress package that is shipped with the Fiber web framework

  1. import (
  2.   "github.com/gofiber/fiber/v2"
  3.   "github.com/gofiber/fiber/v2/middleware/compress"
  4. )

You can pass an optional Config struct to create a new middleware handler.

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

The following configurations are possible

  1. type Config struct {
  2.     // Next defines a function to skip this middleware when returned true.
  3.     //
  4.     // Optional. Default: nil
  5.     Next func(c *fiber.Ctx) bool
  7.     // CompressLevel determines the compression algoritm
  8.     //
  9.     // Optional. Default: LevelDefault
  10.     // LevelDisabled:         -1
  11.     // LevelDefault:          0
  12.     // LevelBestSpeed:        1
  13.     // LevelBestCompression:  2
  14.     Level int
  15. }
  1. // Default compression config
  2. app.Use(compress.New())
  4. // Provide a custom compression level
  5. app.Use(compress.New(compress.Config{
  6.     Level: compress.LevelBestSpeed, // 1
  7. }))
  9. // Skip compression for specific routes
  10. app.Use(compress.New(compress.Config{
  11.   Next:  func(c *fiber.Ctx) bool {
  12.     return c.Path() == "/dont_compress"
  13.   },
  14.   Level: compress.LevelBestSpeed, // 1
  15. }))