Body Dump

O middleware Body Dump captura os payloads de request e response e os passa para um handler registrado. Em geral, ele é usado para debugging ou logging.

Cuidado

Evite Body Dump para payloads grandes, como uploads ou downloads de arquivos. Se precisar usá-lo nessas rotas, adicione uma exceção na função skipper.

Todo o middleware principal fica no pacote middleware:

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

Uso

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

Configuração customizada

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

Configuração

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

As descrições dos campos são geradas dos comentários do código-fonte em inglês.

Campos do código-fonte

Campo	Tipo	Descrição	Código
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

Funções do código-fonte

Tipo	Código
func BodyDump(handler BodyDumpHandler) echo.MiddlewareFunc	L58
func BodyDumpWithConfig(config BodyDumpConfig) echo.MiddlewareFunc	L68

O Handler tem a assinatura:

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

Configuração padrão

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