middleware del analizador del cuerpo

Node.js analizando middleware.

Analiza los cuerpos de la solicitud entrante en un middleware antes de tus manejadores, disponible bajo la propiedad req.body.

Nota como req. La forma de odyse basa en la entrada controlada por el usuario, todas las propiedades y valores en este objeto no son confiables y deben ser validados antes de confiar. Por ejemplo, req.body.foo. oString() puede fallar en múltiples formas , por ejemplo la propiedad foo puede no estar ahí o no ser una cadena, y toString pueden no ser una función y en su lugar una cadena u otra entrada de usuario.

Aprende sobre la anatomía de una transacción HTTP en Node.js.

Esto no maneja cuerpos multipartes, debido a su compleja y típicamente naturaleza grande. For multipart bodies, you may be interested in the following modules:

Este módulo proporciona los siguientes analizadores:

Analizador de cuerpo JSON
Analizador de cuerpo rugoso
Analizador de cuerpo de texto
Analizador del cuerpo del URL codificado

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.

Otros analizadores de cuerpo en los que podría estar interesado:

body
co-body

Instalación

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

El objeto bodyParser expone varias fábricas para crear middlewares. All middlewares will populate the req.body property with the parsed body when the Content-Type request header matches the type option.

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.

Los varios errores devueltos por este módulo se describen en la sección de errores.

bodyParser.json([options])

Devuelve middleware que solo analiza json y solo mira las solicitudes donde la cabecera Content-Type coincide con la opción type. This parser accepts any Unicode encoding of the body.

Un nuevo objeto body que contiene los datos analizados es poblado en el objeto request después del middleware (es decir, req.body).

Opciones

La función json toma un objeto opcional options que puede contener cualquiera de las siguientes claves:

por defecto Charset

Especifica el conjunto de caracteres predeterminado para el contenido json si el conjunto de caracteres no es especificado en la cabecera Content-Type de la solicitud. Por defecto es utf-8.

inflado

Cuando se establece en true, entonces los cuerpos deflados (comprimidos) se inflarán; cuando falso, los cuerpos deflados son rechazados. Por defecto es true.

límite

Controla el tamaño máximo del cuerpo de solicitud. Si este es un número, entonces el valor especifica el número de bytes; si se trata de una cadena, el valor se pasa a la biblioteca bytes para analizar. Por defecto a '100kb'.

Se recomienda no configurar un límite muy alto y utilizar el valor por defecto siempre que sea posible. Permitir cargas mayores aumenta el uso de memoria debido a los recursos necesarios para decodificar y transformar, y también puede llevar a tiempos de respuesta más largos a medida que se procesan más datos. Por “muy alto”, nos referimos a valores por encima del valor predeterminado, por ejemplo las cargas útiles de 5 MB o más ya pueden empezar a introducir estos riesgos. Con los límites por defecto, estos problemas no se producen.

reviver

La opción reviver se pasa directamente a JSON.parse como segundo argumento . You can find more information on this argument in the MDN documentation about JSON.parse.

estricto

When set to true, it will only accept arrays and objects; when false, it will accept anything JSON.parse accepts. Por defecto es true.

tipo

The type option is used to determine what media type the middleware will parse. Esta opción puede ser una cadena, array de cadenas, o una función. If not a function, type option is passed directly to the type-is library and this can be an extension name (like json), a mime type (like application/json), or a mime type with a wildcard (like */* or */json). Si una función, la opción type se llama como fn(req) y la solicitud se analiza si devuelve un valor verdadero. Por defecto es application/json.

verificar

La opción verify, si se suministra, se llama como verify(req, res, buf, encoding), donde buf es un Buffer del cuerpo de la solicitud crudo y encoding es la codificación de la solicitud. El análisis puede ser abortado lanzando un error.

bodyParser.raw([options])

Devuelve middleware que analiza todos los cuerpos como un Buffer y solo mira solicitudes donde la cabecera Content-Type coincide con la opción type.

Un nuevo objeto body que contiene los datos analizados es poblado en el objeto request después del middleware (es decir, req.body). Este será un objeto de Buffer del cuerpo.

Opciones

La función raw toma un objeto opcional options que puede contener cualquiera de las siguientes claves:

inflado

Cuando se establece en true, entonces los cuerpos deflados (comprimidos) se inflarán; cuando falso, los cuerpos deflados son rechazados. Por defecto es true.

límite

Se recomienda no configurar un límite muy alto y utilizar el valor por defecto siempre que sea posible. Permitir cargas mayores aumenta el uso de memoria debido a los recursos necesarios para decodificar y transformar, y también puede llevar a tiempos de respuesta más largos a medida que se procesan más datos. Por “muy alto”, nos referimos a valores por encima del valor predeterminado, por ejemplo las cargas útiles de 5 MB o más ya pueden empezar a introducir estos riesgos. Con los límites por defecto, estos problemas no se producen.

tipo

The type option is used to determine what media type the middleware will parse. Esta opción puede ser una cadena, array de cadenas, o una función. Si no es una función, La opción type se pasa directamente a la biblioteca type-is y esta puede ser un nombre de extensión (como bin), un tipo mime (como application/octet-stream), o un tipo mime con un comodín (como */* o application/*). Si una función, la opción type se llama como fn(req) y la solicitud se analiza si devuelve un valor verdadero. Por defecto es application/octet-stream.

verificar

bodyParser.text([options])

Devuelve middleware que analiza todos los cuerpos como una cadena y solo mira peticiones donde la cabecera Content-Type coincide con la opción 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.

Opciones

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

por defecto Charset

Specify the default character set for the text content if the charset is not specified in the Content-Type header of the request. Por defecto es utf-8.

inflado

Cuando se establece en true, entonces los cuerpos deflados (comprimidos) se inflarán; cuando falso, los cuerpos deflados son rechazados. Por defecto es true.

límite

Se recomienda no configurar un límite muy alto y utilizar el valor por defecto siempre que sea posible. Permitir cargas mayores aumenta el uso de memoria debido a los recursos necesarios para decodificar y transformar, y también puede llevar a tiempos de respuesta más largos a medida que se procesan más datos. Por “muy alto”, nos referimos a valores por encima del valor predeterminado, por ejemplo las cargas útiles de 5 MB o más ya pueden empezar a introducir estos riesgos. Con los límites por defecto, estos problemas no se producen.

tipo

The type option is used to determine what media type the middleware will parse. Esta opción puede ser una cadena, array de cadenas, o una función. 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.

verificar

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 nuevo objeto body que contiene los datos analizados es poblado en el objeto request después del middleware (es decir, 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).

Opciones

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.

inflado

Cuando se establece en true, entonces los cuerpos deflados (comprimidos) se inflarán; cuando falso, los cuerpos deflados son rechazados. Por defecto es true.

límite

Se recomienda no configurar un límite muy alto y utilizar el valor por defecto siempre que sea posible. Permitir cargas mayores aumenta el uso de memoria debido a los recursos necesarios para decodificar y transformar, y también puede llevar a tiempos de respuesta más largos a medida que se procesan más datos. Por “muy alto”, nos referimos a valores por encima del valor predeterminado, por ejemplo las cargas útiles de 5 MB o más ya pueden empezar a introducir estos riesgos. Con los límites por defecto, estos problemas no se producen.

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

The type option is used to determine what media type the middleware will parse. Esta opción puede ser una cadena, array de cadenas, o una función. 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.

verificar

por defecto Charset

The default charset to parse as, if not specified in content-type. Must be either utf-8 or iso-8859-1. Por defecto es 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.

Ejemplos

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

Licencia

MIT