echo/website/content/middleware/body-limit.md

+++ title = "Body Limit Middleware" description = "Body limit middleware for Echo" [menu.main] name = "Body Limit" parent = "middleware" weight = 5 +++

Body limit middleware sets the maximum allowed size for a request body, if the size exceeds the configured limit, it sends "413 - Request Entity Too Large" response. The body limit is determined based on both Content-Length request header and actual content read, which makes it super secure.

Limit can be specified as 4x or 4xB, where x is one of the multiple from K, M, G, T or P.

Usage

e := echo.New()
e.Use(middleware.BodyLimit("2M"))

Custom Configuration

Usage

e := echo.New()
e.Use(middleware.BodyLimitWithConfig(middleware.BodyLimitConfig{}))

Configuration

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

  // Maximum allowed size for a request body, it can be specified
  // as `4x` or `4xB`, where x is one of the multiple from K, M, G, T or P.
  Limit string `json:"limit"`
}

Default Configuration

DefaultBodyLimitConfig = BodyLimitConfig{
  Skipper: defaultSkipper,
}