Body Dump

Body Dump middleware captures the request and response payloads and passes them to a registered handler. It is generally used for debugging or logging.

Caution

Avoid Body Dump for large payloads such as file uploads or downloads. If you must use it on such routes, add an exception in the skipper function.

All core middleware lives in the middleware package:

import "github.com/labstack/echo/v5/middleware"

Usage

e := echo.New()
e.Use(middleware.BodyDump(func(c *echo.Context, reqBody, resBody []byte, err error) {
  // Handle the request and response bodies.
}))

Custom configuration

e := echo.New()
e.Use(middleware.BodyDumpWithConfig(middleware.BodyDumpConfig{}))

Configuration

BodyDumpConfig · github.com/labstack/echo/v5@5196b9b

Fields from package source

Field	Type	Description	Source
Skipper	Skipper	Skipper defines a function to skip middleware.	L21
Handler	BodyDumpHandler	Handler receives request, response payloads and handler error if there are any. Required.	L25
MaxRequestBytes	int64	MaxRequestBytes limits how much of the request body to dump. If the request body exceeds this limit, only the first MaxRequestBytes are dumped. The handler callback receives truncated data. Default: 5 * MB (5,242,880 bytes) Set to -1 to disable limits (not recommended in production).	L32
MaxResponseBytes	int64	MaxResponseBytes limits how much of the response body to dump. If the response body exceeds this limit, only the first MaxResponseBytes are dumped. The handler callback receives truncated data. Default: 5 * MB (5,242,880 bytes) Set to -1 to disable limits (not recommended in production).	L39

Functions from package source

Type	Source
func BodyDump(handler BodyDumpHandler) echo.MiddlewareFunc	L58
func BodyDumpWithConfig(config BodyDumpConfig) echo.MiddlewareFunc	L68

The Handler has the signature:

type BodyDumpHandler func(c *echo.Context, reqBody []byte, resBody []byte, err error)

Default configuration

// Effective defaults applied when fields are left unset (Handler is required).
BodyDumpConfig{
  Skipper:          DefaultSkipper,
  MaxRequestBytes:  5 * MB,
  MaxResponseBytes: 5 * MB,
}