body-parser middleware

Node.js body parsing middleware.

Analizza i corpi di richiesta in arrivo in un middleware prima dei tuoi gestori, disponibili sotto la proprietà req.body.

Note As req.body’s shape is based on user-controlled input, all properties and values in this object are untrusted and should be validated before trusting. Per esempio, req.body.foo. oString() potrebbe fallire in più modi , per esempio la proprietà foo potrebbe non esserci o non essere una stringa, e toString potrebbero non essere una funzione e invece una stringa o un altro input utente.

Scopri l’anatomia di una transazione HTTP in Node.js.

This does not handle multipart bodies, due to their complex and typically large nature. Per i corpi multipart, potresti essere interessato ai seguenti moduli :

Questo modulo fornisce i seguenti parser:

JSON body parser
Parser corpo grezzo
Analizzatore corpo testo
analizzatore di forma codificata URL

All parsers support automatic inflation of gzip, br (brotli), deflate and zstd encodings. zstd is available in Node.js ^22.15.0 and >=23.8.0.

Altri analizzatori del corpo che potrebbero interessarti:

body
co-body

Installazione

npm install body-parser

Note

body-parser does not include its own TypeScript type definitions. If you use TypeScript, also install the community-maintained types from DefinitelyTyped as a development dependency:

npm install --save-dev @types/body-parser

API

// Import all parsers
const bodyParser = require('body-parser');

// Or import individual parsers directly
const json = require('body-parser/json');
const urlencoded = require('body-parser/urlencoded');
const raw = require('body-parser/raw');
const text = require('body-parser/text');

L’oggetto bodyParser espone varie fabbriche per creare middlewares. Tutti i middlewares popoleranno la proprietà req.body con il corpo analizzato quando l’intestazione della richiesta Content-Type corrisponde all’opzione type.

Note As of v2, req.body is left undefined when no body is parsed (for example when the request has neither Content-Length nor Transfer-Encoding, or when Content-Type does not match). In v1, req.body was always initialized to {}. Code that assumes req.body is always an object should use optional chaining (for example req.body?.username) or set a default.

I vari errori restituiti da questo modulo sono descritti nella sezione Errori.

bodyParser.json([options])

Restituisce middleware che analizza solo json e guarda solo le richieste dove l’intestazione Content-Type corrisponde all’opzione type. This parser accepts any Unicode encoding of the body.

Un nuovo oggetto body contenente i dati analizzati viene compilato sull’oggetto request dopo il middleware (es. req.body).

Opzioni

La funzione json richiede un oggetto options opzionale che può contenere una qualsiasi di le seguenti chiavi:

defaultCharset

Specifica il set di caratteri predefinito per il contenuto json se il set di caratteri non è specificato nell’intestazione Content-Type della richiesta. Il valore predefinito è utf-8.

gonfiare

Quando impostato a true, allora i corpi sgonfiati (compressi) saranno gonfiati; quando falso, i corpi sgonfiati vengono rifiutati. Il valore predefinito è true.

limite

Controlla la dimensione massima del corpo richiesto. Se questo è un numero, allora il valore specifica il numero di byte; se si tratta di una stringa, il valore viene passato alla libreria bytes da analizzare. Il valore predefinito è '100kb'.

Si consiglia di non configurare un limite molto alto e di utilizzare il valore predefinito quando possibile. Consentire carichi di pagamento più grandi aumenta l’utilizzo della memoria a causa delle risorse necessarie per la decodifica e le trasformazioni, e può anche portare a tempi di risposta più lunghi come più dati vengono elaborati. Per ‘molto alto’, intendiamo valori superiori al valore predefinito, per esempio payload di 5 MB o più possono già iniziare a introdurre questi rischi. Con i limiti predefiniti, questi problemi non si verificano.

reviver

L’opzione reviver viene passata direttamente a JSON.parse come secondo argomento . You can find more information on this argument in the MDN documentation about JSON.parse.

rigoroso

When set to true, it will only accept arrays and objects; when false, it will accept anything JSON.parse accepts. Il valore predefinito è true.

tipo

L’opzione type è usata per determinare quale tipo di media il middleware analizzerà . Questa opzione può essere una stringa, un array di stringhe o una funzione. Se non è una funzione , L’opzione type è passata direttamente alla libreria type-is e può essere un nome di estensione (come json), un tipo mime (come application/json), o un tipo mime con un carattere jolly (come */* o */json). Se una funzione, l’opzione type è chiamata fn(req) e la richiesta viene analizzata se restituisce un valore vero . Il valore predefinito è application/json.

verifica

L’opzione verify, se fornita, è chiamata verify(req, res, buf, encoding), dove buf è un Buffer del corpo di richiesta grezzo e encoding è la codifica della richiesta. L’analisi può essere interrotta lanciando un errore.

bodyParser.raw([options])

Restituisce il middleware che analizza tutti i corpi come Buffer e guarda solo le richieste dove l’intestazione Content-Type corrisponde all’opzione type.

Un nuovo oggetto body contenente i dati analizzati viene compilato sull’oggetto request dopo il middleware (es. req.body). Questo sarà un oggetto Buffer del corpo.

Opzioni

La funzione raw richiede un oggetto options opzionale che può contenere una qualsiasi di le seguenti chiavi:

gonfiare

Quando impostato a true, allora i corpi sgonfiati (compressi) saranno gonfiati; quando falso, i corpi sgonfiati vengono rifiutati. Il valore predefinito è true.

limite

Si consiglia di non configurare un limite molto alto e di utilizzare il valore predefinito quando possibile. Consentire carichi di pagamento più grandi aumenta l’utilizzo della memoria a causa delle risorse necessarie per la decodifica e le trasformazioni, e può anche portare a tempi di risposta più lunghi come più dati vengono elaborati. Per ‘molto alto’, intendiamo valori superiori al valore predefinito, per esempio payload di 5 MB o più possono già iniziare a introdurre questi rischi. Con i limiti predefiniti, questi problemi non si verificano.

tipo

L’opzione type è usata per determinare quale tipo di media il middleware analizzerà . Questa opzione può essere una stringa, un array di stringhe o una funzione. Se non una funzione, L’opzione type è passata direttamente alla libreria type-is e questa può essere un nome di estensione (come bin), un tipo mime (come application/octet-stream), o un tipo mime con un carattere jolly (come */* o application/*). Se una funzione, l’opzione type è chiamata fn(req) e la richiesta viene analizzata se restituisce un valore vero. Il valore predefinito è application/octet-stream.

verifica

bodyParser.text([options])

Restituisce middleware che analizza tutti i corpi come una stringa e guarda solo le richieste dove l’intestazione Content-Type corrisponde all’opzione type.

A new body string containing the parsed data is populated on the request object after the middleware (i.e. req.body). This will be a string of the body.

Opzioni

The text function takes an optional options object that may contain any of the following keys:

defaultCharset

Specify the default character set for the text content if the charset is not specified in the Content-Type header of the request. Il valore predefinito è utf-8.

gonfiare

Quando impostato a true, allora i corpi sgonfiati (compressi) saranno gonfiati; quando falso, i corpi sgonfiati vengono rifiutati. Il valore predefinito è true.

limite

Si consiglia di non configurare un limite molto alto e di utilizzare il valore predefinito quando possibile. Consentire carichi di pagamento più grandi aumenta l’utilizzo della memoria a causa delle risorse necessarie per la decodifica e le trasformazioni, e può anche portare a tempi di risposta più lunghi come più dati vengono elaborati. Per ‘molto alto’, intendiamo valori superiori al valore predefinito, per esempio payload di 5 MB o più possono già iniziare a introdurre questi rischi. Con i limiti predefiniti, questi problemi non si verificano.

tipo

L’opzione type è usata per determinare quale tipo di media il middleware analizzerà . Questa opzione può essere una stringa, un array di stringhe o una funzione. If not a function, type option is passed directly to the type-is library and this can be an extension name (like txt), a mime type (like text/plain), or a mime type with a wildcard (like */* or text/*). If a function, the type option is called as fn(req) and the request is parsed if it returns a truthy value. Defaults to text/plain.

verifica

bodyParser.urlencoded([options])

Returns middleware that only parses urlencoded bodies and only looks at requests where the Content-Type header matches the type option. This parser accepts only UTF-8 and ISO-8859-1 encodings of the body.

Un nuovo oggetto body contenente i dati analizzati viene compilato sull’oggetto request dopo il middleware (es. req.body). This object will contain key-value pairs, where the value can be a string or array (when extended is false), or any type (when extended is true).

Opzioni

The urlencoded function takes an optional options object that may contain any of the following keys:

extended

The “extended” syntax allows for rich objects and arrays to be encoded into the URL-encoded format, allowing for a JSON-like experience with URL-encoded. For more information, please see the qs library.

Defaults to false.

gonfiare

Quando impostato a true, allora i corpi sgonfiati (compressi) saranno gonfiati; quando falso, i corpi sgonfiati vengono rifiutati. Il valore predefinito è true.

limite

Si consiglia di non configurare un limite molto alto e di utilizzare il valore predefinito quando possibile. Consentire carichi di pagamento più grandi aumenta l’utilizzo della memoria a causa delle risorse necessarie per la decodifica e le trasformazioni, e può anche portare a tempi di risposta più lunghi come più dati vengono elaborati. Per ‘molto alto’, intendiamo valori superiori al valore predefinito, per esempio payload di 5 MB o più possono già iniziare a introdurre questi rischi. Con i limiti predefiniti, questi problemi non si verificano.

parameterLimit

The parameterLimit option controls the maximum number of parameters that are allowed in the URL-encoded data. If a request contains more parameters than this value, a 413 will be returned to the client. Defaults to 1000.

tipo

L’opzione type è usata per determinare quale tipo di media il middleware analizzerà . Questa opzione può essere una stringa, un array di stringhe o una funzione. If not a function, type option is passed directly to the type-is library and this can be an extension name (like urlencoded), a mime type (like application/x-www-form-urlencoded), or a mime type with a wildcard (like */x-www-form-urlencoded). If a function, the type option is called as fn(req) and the request is parsed if it returns a truthy value. Defaults to application/x-www-form-urlencoded.

verifica

defaultCharset

The default charset to parse as, if not specified in content-type. Must be either utf-8 or iso-8859-1. Il valore predefinito è utf-8.

charsetSentinel

Whether to let the value of the utf8 parameter take precedence as the charset selector. It requires the form to contain a parameter named utf8 with a value of ✓. Defaults to false.

interpretNumericEntities

Whether to decode numeric entities such as ☺ when parsing an iso-8859-1 form. Defaults to false.

depth

The depth option is used to configure the maximum depth of the qs library when extended is true. This allows you to limit the amount of keys that are parsed and can be useful to prevent certain types of abuse. Defaults to 32. It is recommended to keep this value as low as possible.

Errors

The middlewares provided by this module create errors using the http-errors module. The errors will typically have a status/statusCode property that contains the suggested HTTP response code, an expose property to determine if the message property should be displayed to the client, a type property to determine the type of error without matching against the message, and a body property containing the read body, if available.

The following are the common errors created, though any error can come through for various reasons.

content encoding unsupported

This error will occur when the request had a Content-Encoding header that contained an encoding but the “inflation” option was set to false. The status property is set to 415, the type property is set to 'encoding.unsupported', and the charset property will be set to the encoding that is unsupported.

entity parse failed

This error will occur when the request contained an entity that could not be parsed by the middleware. The status property is set to 400, the type property is set to 'entity.parse.failed', and the body property is set to the entity value that failed parsing.

entity verify failed

This error will occur when the request contained an entity that could not be verified by the defined verify option. The status property is set to 403, the type property is set to 'entity.verify.failed', and the body property is set to the entity value that failed verification.

request aborted

This error will occur when the request is aborted by the client before reading the body has finished. The received property will be set to the number of bytes received before the request was aborted and the expected property is set to the number of expected bytes. The status property is set to 400 and type property is set to 'request.aborted'.

request entity too large

This error will occur when the request body’s size is larger than the “limit” option. The limit property will be set to the byte limit and the length property will be set to the request body’s length. The status property is set to 413 and the type property is set to 'entity.too.large'.

request size did not match content length

This error will occur when the request’s length did not match the length from the Content-Length header. This typically occurs when the request is malformed, typically when the Content-Length header was calculated based on characters instead of bytes. The status property is set to 400 and the type property is set to 'request.size.invalid'.

stream encoding should not be set

This error will occur when something called the req.setEncoding method prior to this middleware. This module operates directly on bytes only and you cannot call req.setEncoding when using this module. The status property is set to 500 and the type property is set to 'stream.encoding.set'.

stream is not readable

This error will occur when the request is no longer readable when this middleware attempts to read it. This typically means something other than a middleware from this module read the request body already and the middleware was also configured to read the same request. The status property is set to 500 and the type property is set to 'stream.not.readable'.

too many parameters

This error will occur when the content of the request exceeds the configured parameterLimit for the urlencoded parser. The status property is set to 413 and the type property is set to 'parameters.too.many'.

unsupported charset “BOGUS”

This error will occur when the request had a charset parameter in the Content-Type header, but the iconv-lite module does not support it OR the parser does not support it. The charset is contained in the message as well as in the charset property. The status property is set to 415, the type property is set to 'charset.unsupported', and the charset property is set to the charset that is unsupported.

unsupported content encoding “bogus”

This error will occur when the request had a Content-Encoding header that contained an unsupported encoding. The encoding is contained in the message as well as in the encoding property. The status property is set to 415, the type property is set to 'encoding.unsupported', and the encoding property is set to the encoding that is unsupported.

The input exceeded the depth

This error occurs when using bodyParser.urlencoded with the extended property set to true and the input exceeds the configured depth option. The status property is set to 400. It is recommended to review the depth option and evaluate if it requires a higher value. With the default depth of 32, an input with 33 or more levels of nesting gets this error.

Esempi

Express/Connect top-level generic

This example demonstrates adding a generic JSON and URL-encoded parser as a top-level middleware, which will parse the bodies of all incoming requests. This is the simplest setup.

const express = require('express');
const bodyParser = require('body-parser');

const app = express();

// parse application/x-www-form-urlencoded
app.use(bodyParser.urlencoded());

// parse application/json
app.use(bodyParser.json());

app.use(function (req, res) {
  res.setHeader('Content-Type', 'text/plain');
  res.write('you posted:\n');
  res.end(String(JSON.stringify(req.body, null, 2)));
});

Express route-specific

This example demonstrates adding body parsers specifically to the routes that need them. In general, this is the most recommended way to use body-parser with Express.

const express = require('express');
const bodyParser = require('body-parser');

const app = express();

// create application/json parser
const jsonParser = bodyParser.json();

// create application/x-www-form-urlencoded parser
const urlencodedParser = bodyParser.urlencoded();

// POST /login gets urlencoded bodies
app.post('/login', urlencodedParser, function (req, res) {
  if (!req.body || !req.body.username) res.sendStatus(400);
  res.send('welcome, ' + req.body.username);
});

// POST /api/users gets JSON bodies
app.post('/api/users', jsonParser, function (req, res) {
  if (!req.body) res.sendStatus(400);
  // create user in req.body
});

Change accepted type for parsers

All the parsers accept a type option which allows you to change the Content-Type that the middleware will parse.

const express = require('express');
const bodyParser = require('body-parser');

const app = express();

// parse various different custom JSON types as JSON
app.use(bodyParser.json({ type: 'application/*+json' }));

// parse some custom thing into a Buffer
app.use(bodyParser.raw({ type: 'application/vnd.custom-type' }));

// parse an HTML body into a string
app.use(bodyParser.text({ type: 'text/html' }));

Licenza

MIT