body-parser middleware

Analyse du corps du middleware de Node.js.

Analyser les corps des requêtes entrantes dans un middleware avant vos gestionnaires, disponible sous la propriété req.body.

Note comme req. la forme d'ody est basée sur l’entrée contrôlée par l’utilisateur, toutes les propriétés et les valeurs de cet objet ne sont pas fiables et doivent être validées avant de faire confiance. Par exemple, req.body.foo. oString() peut échouer dans plusieurs manières , par exemple la propriété foo peut ne pas être là ou peut ne pas être une chaîne, et toString ne peuvent pas être une fonction et à la place une chaîne de caractères ou une autre entrée utilisateur.

En savoir plus sur l’anatomie d’une transaction HTTP dans Node.js.

Ceci ne gère pas les corps multiparties, en raison de leur nature complexe et typiquement grande. Pour les corps multipartites, vous pourriez être intéressé par les modules suivants :

Ce module fournit les analyseurs suivants :

JSON body parser
Analyseur de corps brut
Analyseur de corps de texte
(#bodyparserurlencodedoptions)

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.

Autres analyseurs de corps qui pourraient vous intéresser:

body
co-body

Installation

npm install body-parser

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’objet bodyParser expose diverses usines pour créer des middlewares. Tous les middlewares rempliront la propriété req.body avec le corps analysé quand l’en-tête de requête Content-Type correspond à l’option 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.

Les différentes erreurs retournées par ce module sont décrites dans la section erreurs section.

bodyParser.json([options])

Retourne un middleware qui n’analyse que json et ne regarde que les requêtes où l’en-tête Content-Type correspond à l’option type. This parser accepts any Unicode encoding of the body.

Un nouvel objet body contenant les données analysées est peuplé sur l’objet request après le middleware (c’est-à-dire req.body).

Options

La fonction json prend un objet optionnel options qui peut contenir n’importe laquelle de des clés suivantes:

Charset par défaut

Spécifie le jeu de caractères par défaut pour le contenu json si le jeu de caractères n’est pas spécifié dans l’en-tête Content-Type de la requête. utf-8 par défaut.

gonfler

Quand réglé sur true, alors les corps dégonflés (compressés) seront gonflés ; quand false, les corps dégonflés sont rejetés. true par défaut.

limite

Contrôle la taille maximale du corps de la requête. Si c’est un nombre, alors la valeur spécifie le nombre d’octets; si c’est une chaîne, la valeur est passée à la bibliothèque bytes à analyser. Par défaut, est '100kb'.

Il est recommandé de ne pas configurer une limite très élevée et d’utiliser la valeur par défaut dès que possible. Autoriser des charges plus importantes augmente l’utilisation de la mémoire en raison des ressources requises pour le décodage et les transformations, et il peut également conduire à des temps de réponse plus longs à mesure que plus de données sont traitées. Par «très haut», nous entendons les valeurs au-dessus de la valeur par défaut, par exemple des charges de 5 Mo ou plus peuvent déjà commencer à introduire ces risques. Avec les limites par défaut, ces problèmes ne se produisent pas.

reviver

L’option reviver est passée directement à JSON.parse en tant que deuxième argument . You can find more information on this argument in the MDN documentation about JSON.parse.

strict

When set to true, it will only accept arrays and objects; when false, it will accept anything JSON.parse accepts. true par défaut.

Type de type

The type option is used to determine what media type the middleware will parse. Cette option peut être une chaîne, un tableau de chaînes de caractères ou une fonction. Si ce n’est pas une fonction , L’option type est passée directement à la bibliothèque type-is et cela peut être un nom d’extension (comme json), un type mime (comme application/json), ou un type mime avec un caractère générique (comme */* ou */json). Si une fonction, l’option type est appelée comme fn(req) et la requête est analysée si elle renvoie une valeur Truthy . Par défaut, application/json.

vérifier

L’option verify, si fourni, est appelée comme verify(req, res, buf, encoding), où buf est un Buffer du corps de la requête brute et encoding est l’encodage de la requête. L’analyse peut être annulée en lançant une erreur.

bodyParser.raw([options])

Retourne un middleware qui analyse tous les corps comme un Buffer et regarde seulement les requêtes où l’en-tête Content-Type correspond à l’option type.

Un nouvel objet body contenant les données analysées est peuplé sur l’objet request après le middleware (c’est-à-dire req.body). Ce sera un objet Buffer du corps.

Options

La fonction raw prend un objet optionnel options qui peut contenir n’importe laquelle de des clés suivantes:

gonfler

Quand réglé sur true, alors les corps dégonflés (compressés) seront gonflés ; quand false, les corps dégonflés sont rejetés. true par défaut.

limite

Il est recommandé de ne pas configurer une limite très élevée et d’utiliser la valeur par défaut dès que possible. Autoriser des charges plus importantes augmente l’utilisation de la mémoire en raison des ressources requises pour le décodage et les transformations, et il peut également conduire à des temps de réponse plus longs à mesure que plus de données sont traitées. Par «très haut», nous entendons les valeurs au-dessus de la valeur par défaut, par exemple des charges de 5 Mo ou plus peuvent déjà commencer à introduire ces risques. Avec les limites par défaut, ces problèmes ne se produisent pas.

Type de type

The type option is used to determine what media type the middleware will parse. Cette option peut être une chaîne, un tableau de chaînes de caractères ou une fonction. Si ce n’est pas une fonction, L’option type est passée directement à la bibliothèque type-is et ce peut être un nom d’extension (comme bin), un type mime (comme application/octet-stream), ou un type mime avec un caractère générique (comme */* ou application/*). Si une fonction, l’option type est appelée comme fn(req) et la requête est analysée si elle renvoie une valeur vraie. Par défaut, application/octet-stream.

vérifier

bodyParser.text([options])

Retourne un middleware qui analyse tous les corps comme une chaîne de caractères et ne regarde que les requêtes où l’en-tête Content-Type correspond à l’option 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.

Options

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

Charset par défaut

Specify the default character set for the text content if the charset is not specified in the Content-Type header of the request. utf-8 par défaut.

gonfler

Quand réglé sur true, alors les corps dégonflés (compressés) seront gonflés ; quand false, les corps dégonflés sont rejetés. true par défaut.

limite

Il est recommandé de ne pas configurer une limite très élevée et d’utiliser la valeur par défaut dès que possible. Autoriser des charges plus importantes augmente l’utilisation de la mémoire en raison des ressources requises pour le décodage et les transformations, et il peut également conduire à des temps de réponse plus longs à mesure que plus de données sont traitées. Par «très haut», nous entendons les valeurs au-dessus de la valeur par défaut, par exemple des charges de 5 Mo ou plus peuvent déjà commencer à introduire ces risques. Avec les limites par défaut, ces problèmes ne se produisent pas.

Type de type

The type option is used to determine what media type the middleware will parse. Cette option peut être une chaîne, un tableau de chaînes de caractères ou une fonction. 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.

vérifier

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 nouvel objet body contenant les données analysées est peuplé sur l’objet request après le middleware (c’est-à-dire 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).

Options

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.

gonfler

Quand réglé sur true, alors les corps dégonflés (compressés) seront gonflés ; quand false, les corps dégonflés sont rejetés. true par défaut.

limite

Il est recommandé de ne pas configurer une limite très élevée et d’utiliser la valeur par défaut dès que possible. Autoriser des charges plus importantes augmente l’utilisation de la mémoire en raison des ressources requises pour le décodage et les transformations, et il peut également conduire à des temps de réponse plus longs à mesure que plus de données sont traitées. Par «très haut», nous entendons les valeurs au-dessus de la valeur par défaut, par exemple des charges de 5 Mo ou plus peuvent déjà commencer à introduire ces risques. Avec les limites par défaut, ces problèmes ne se produisent pas.

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.

Type de type

The type option is used to determine what media type the middleware will parse. Cette option peut être une chaîne, un tableau de chaînes de caractères ou une fonction. 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.

vérifier

Charset par défaut

The default charset to parse as, if not specified in content-type. Must be either utf-8 or iso-8859-1. utf-8 par défaut.

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.

Exemples

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' }));

Licence

MIT