Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

+++ title = "Gzip Middleware" description = "Gzip middleware for Echo" [menu.main] name = "Gzip" parent = "middleware" +++

Gzip middleware compresses HTTP response using gzip compression scheme.

Usage

e.Use(middleware.Gzip())

Custom Configuration

Usage

e := echo.New()
e.Use(middleware.GzipWithConfig(middleware.GzipConfig{
  Level: 5,
}))

Configuration

GzipConfig struct {
  // Skipper defines a function to skip middleware.
  Skipper Skipper

  // Gzip compression level.
  // Optional. Default value -1.
  Level int `json:"level"`
}

Default Configuration

DefaultGzipConfig = GzipConfig{
  Skipper: DefaultSkipper,
  Level:   -1,
}

Middleware Skipper

A middleware skipper can be passed to avoid gzip to certain URLs:

Usage

e := echo.New()
e.Use(middleware.GzipWithConfig(middleware.GzipConfig{
  Skipper: func(c echo.Context) bool {
    return strings.Contains(c.Path(), "metrics") // Change "metrics" for your own path
  },
}))