ChatGPT解决这个技术问题 Extra ChatGPT

Express.js req.body undefined

I have this as configuration of my Express server

app.use(app.router); 
app.use(express.cookieParser());
app.use(express.session({ secret: "keyboard cat" }));
app.set('view engine', 'ejs');
app.set("view options", { layout: true });
//Handles post requests
app.use(express.bodyParser());
//Handles put requests
app.use(express.methodOverride());

But still when I ask for req.body.something in my routes I get some error pointing out that body is undefined. Here is an example of a route that uses req.body :

app.post('/admin', function(req, res){
    console.log(req.body.name);
});

I read that this problem is caused by the lack of app.use(express.bodyParser()); but as you can see I call it before the routes.

Any clue?

It's not really a solution to your problem but as this is the first thread that results from google I will state it here, make sure there are no other misbehaving middlewares used.

S
Safin Ghoghabori

UPDATE July 2020

express.bodyParser() is no longer bundled as part of express. You need to install it separately before loading:

npm i body-parser

// then in your app
var express = require('express')
var bodyParser = require('body-parser')
 
var app = express()
 
// create application/json parser
var jsonParser = bodyParser.json()
 
// create application/x-www-form-urlencoded parser
var urlencodedParser = bodyParser.urlencoded({ extended: false })
 
// POST /login gets urlencoded bodies
app.post('/login', urlencodedParser, function (req, res) {
  res.send('welcome, ' + req.body.username)
})
 
// POST /api/users gets JSON bodies
app.post('/api/users', jsonParser, function (req, res) {
  // create user in req.body
})

See here for further info

original follows

You must make sure that you define all configurations BEFORE defining routes. If you do so, you can continue to use express.bodyParser().

An example is as follows:

var express = require('express'),
    app     = express(),
    port    = parseInt(process.env.PORT, 10) || 8080;

app.configure(function(){
  app.use(express.bodyParser());
});

app.listen(port);
    
app.post("/someRoute", function(req, res) {
  console.log(req.body);
  res.send({ status: 'SUCCESS' });
});

This worked for me. Note: Unfortunately, some tutorials out there have people (like me) putting routes before app.configure(). In my case this was in the form of app.get/post etc, and a require() including them.
as of express 4, app.use(app.router) is removed. please see the docs github.com/visionmedia/express/wiki/New-features-in-4.x
as of express 4, middlewares like bodyParser are no longer bundled with Express and must be installed separately. You can find more informations here: github.com/senchalabs/connect#middleware.
looks like your second part was the solution to my problem, I had a mail.js module that was imported before the body-parser. but weird because I added thee body-parser middleware in mail.js itself.
From version 4.16.0 Express exposes the json() and urlencoded() middlewares directly from bodyParser, so you can just import { json } from "express"; if those two middlewares are all you need. Is there a reason why someone shouldn't do this?
J
Jay

Latest versions of Express (4.x) has unbundled the middleware from the core framework. If you need body parser, you need to install it separately

npm install body-parser --save

and then do this in your code

var bodyParser = require('body-parser')
var app = express()

// parse application/x-www-form-urlencoded
app.use(bodyParser.urlencoded({ extended: false }))

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

I recently updated to express 4.x. Initially when I was trying to log req.body It was showing me undefined. Once I have installed and used body-parser, It is giving me expected req.body values. :)
I found this useful when trying to work out why my POST requests weren't working with json-server.
app.use(bodyParser.urlencoded({ extended: false })); app.use(bodyParser.json()) saved me !!
While this is true, you must also ensure that the parser configuration takes place before the routes are added. I'd already done the express 4.x thing, but including the routes after the parsing was set up made all the difference to me.
T
TechTurtle

Express 4, has build-in body parser. No need to install separate body-parser. So below will work:

export const app = express();
app.use(express.json());

d
danmactough

No. You need to use app.use(express.bodyParser()) before app.use(app.router). In fact, app.use(app.router) should be the last thing you call.


Even moving app.use(app.router) under the .use calls doesn't solve the issue :(.
Ok after a bit of struggling I solved it using app.use(require('connect').bodyParser()); instead of app.use(express.bodyParser());.
yes, answer is true even when using var router=express.Router();
Slight addendum, you should still call error-handling middleware after the app.router
Uncaught Error: Most middleware (like bodyParser) is no longer bundled with Express and must be installed separately. Please see github.com/senchalabs/connect#middleware.
j
jubalm

First make sure , you have installed npm module named 'body-parser' by calling :

npm install body-parser --save

Then make sure you have included following lines before calling routes

var express = require('express');
var bodyParser = require('body-parser');
var app = express();

app.use(bodyParser.json());

If it is using express.json, then why import body-parser?
epic answer bro, quick and working
K
Kevin Xue

The Content-Type in request header is really important, especially when you post the data from curl or any other tools.

Make sure you're using some thing like application/x-www-form-urlencoded, application/json or others, it depends on your post data. Leave this field empty will confuse Express.


+1 This was the problem for me. I was using Postman for Chrome to test a JSON api built in REST, but the object received by Express was empty every time. Turns out Postman by default does not automatically add the 'Content-Type: application/json' header even if you select raw > json.
@Jordan +1 Thanks for pointing this out. Indeed I just checked my headers and I see it's still set to 'text/plain' even though I selected 'json'.
n
nbro

As already posted under one comment, I solved it using

app.use(require('connect').bodyParser());

instead of

app.use(express.bodyParser());

I still don't know why the simple express.bodyParser() is not working...


@Masiar This is not working for me. i'm using expressjs 4 & i get error like this. Error: Cannot find module 'connect'
@JeyTheva mine is a pretty old solution, thus things may have changed in the mean time. I suggest you try to install the connect module via npm install connect and retry. This is the only thing I can think of by reading the output of your error.
Here's the latest documentation for solving this issue: npmjs.com/package/body-parser For others that experience this issue "post express 4", what worked for me was setting the Content-Type header to application/json.
Here's the latest documentation for solving this issue: npmjs.com/package/body-parser After getting body-parser installed, it still didn't work. What did work was setting the Content-Type header to application/json when I was doing my request.
application/json vs text/json in the request works, as suggested by @GrantEagon.
S
Spring

Add in your app.js

before the call of the Router

const app = express();
app.use(express.json());

I tried many solutions mentioned in this post. But this one works. Add app.use(express.json()) before the router. Simple :). Thanks a lot.
e
emkarachchi
app.use(express.json());

It will help to solve the issue of req.body undefined


Đ
Đăng Khoa Đinh

The question is answered. But since it is quite generic and req.body undefined is a frequent error, especially for beginners, I find this is the best place to resume all that I know about the problem.

This error can be caused by the following reasons:

1. [SERVER side] [Quite often] Forget or misused parser middleware

You need to use appropriate middleware to parse the incoming requests. For example, express.json() parses request in JSON format, and express.urlencoded() parses request in urlencoded format.

const app = express();
app.use(express.urlencoded())
app.use(express.json())

You can see the full list in the express documentation page

You should use the parser middleware before the route declaration part (I did a test to confirm this!). The middleware can be configured right after the initialization express app.

Like other answers pointed out, bodyParser is deprecated since express 4.16.0, you should use built-in middlewares like above.

2. [CLIENT side] [Rarely] Forget to send the data along with the request

Well, you need to send the data...

To verify whether the data has been sent with the request or not, open the Network tabs in the browser's devtools and search for your request.

It's rare but I saw some people trying to send data in the GET request, for GET request req.body is undefined.

3. [SERVER & CLIENT] [Quite often] Using different Content-Type

Server and client need to use the same Content-Type to understand each other. If you send requests using json format, you need to use json() middleware. If you send a request using urlencoded format, you need to use urlencoded()...

There is 1 tricky case when you try to upload a file using the form-data format. For that, you can use multer, a middleware for handling multipart/form-data.

What if you don't control the client part? I had a problem when coding the API for Instant payment notification (IPN). The general rule is to try to get information on the client part: communicate with the frontend team, go to the payment documentation page... You might need to add appropriate middleware based on the Content-Type decided by the client part.

Finally, a piece of advice for full-stack developers :)

When having a problem like this, try to use some API test software like Postman. The object is to eliminate all the noise in the client part, this will help you correctly identify the problem.

https://i.stack.imgur.com/wSpxm.png


P
Parwat Kunwar
// Require body-parser (to receive post data from clients)

var bodyParser = require('body-parser');

app.use(bodyParser.urlencoded({ extended: false }))

// parse application/json

app.use(bodyParser.json())

P
Praneesh

Looks like the body-parser is no longer shipped with express. We may have to install it separately.

var express    = require('express')
var bodyParser = require('body-parser')
var app = express()

// parse application/x-www-form-urlencoded
app.use(bodyParser.urlencoded({ extended: false }))

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

// parse application/vnd.api+json as json
app.use(bodyParser.json({ type: 'application/vnd.api+json' }))
app.use(function (req, res, next) {
console.log(req.body) // populated!

Refer to the git page https://github.com/expressjs/body-parser for more info and examples.


This appears to be the new Express 4.x format and worked for me. The express.bodyParser() mentioned in other answers doesn't work in 4.x.
J
Jeff Beagley

In case anyone runs into the same issue I was having; I am using a url prefix like

http://example.com/api/

which was setup with router

app.use('/api', router); 

and then I had the following

app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: true }));

What fixed my issue was placing the bodyparser configuration above app.use('/api', router);

Final

// setup bodyparser
    app.use(bodyParser.json());
    app.use(bodyParser.urlencoded({ extended: true }));

//this is a fix for the prefix of example.com/api/ so we dont need to code the prefix in every route
    app.use('/api', router); 

A
ANIK ISLAM SHOJIB

Most of the time req.body is undefined due to missing JSON parser

const express = require('express');
app.use(express.json());

could be missing for the body-parser

const bodyParser  = require('body-parser');
app.use(bodyParser.urlencoded({extended: true}));

and sometimes it's undefined due to cros origin so add them

const cors = require('cors');
app.use(cors())

S
Sonali Mangrinda

The middleware is always used as first.

//MIDDLEWARE
app.use(bodyParser.json());
app.use(cors());    
app.use(cookieParser());

before the routes.

//MY ROUTES
app.use("/api", authRoutes);

There is no need for it to be placed before other middleware (unless that middleware depends on the body having been parsed, which those examples do not)
a
ab107

express.bodyParser() needs to be told what type of content it is that it's parsing. Therefore, you need to make sure that when you're executing a POST request, that you're including the "Content-Type" header. Otherwise, bodyParser may not know what to do with the body of your POST request.

If you're using curl to execute a POST request containing some JSON object in the body, it would look something like this:

curl -X POST -H "Content-Type: application/json" -d @your_json_file http://localhost:xxxx/someRoute

If using another method, just be sure to set that header field using whatever convention is appropriate.


u
user1614168

Use app.use(bodyparser.json()); before routing. // . app.use("/api", routes);


A
Anthony Cantellano

You can try adding this line of code at the top, (after your require statements):

app.use(bodyParser.urlencoded({extended: true}));

As for the reasons as to why it works, check out the docs: https://www.npmjs.com/package/body-parser#bodyparserurlencodedoptions


I mean, your answer is correct, but it's no different to the others.
M
Mayur

History:

Earlier versions of Express used to have a lot of middleware bundled with it. bodyParser was one of the middleware that came with it. When Express 4.0 was released they decided to remove the bundled middleware from Express and make them separate packages instead. The syntax then changed from app.use(express.json()) to app.use(bodyParser.json()) after installing the bodyParser module.

bodyParser was added back to Express in release 4.16.0, because people wanted it bundled with Express like before. That means you don't have to use bodyParser.json() anymore if you are on the latest release. You can use express.json() instead.

The release history for 4.16.0 is here for those who are interested, and the pull request is here.

Okay, back to the point,

Implementation:

All you need to add is just add,

app.use(express.json());
app.use(express.urlencoded({ extended: true}));
app.use(app.router); // Route will be at the end of parser

And remove bodyParser (in newer version of express it is not needed)

app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: true }));

And Express will take care of your request. :)

Full example will looks like,

const express       = require('express')
const app           = express()

app.use(express.json())
app.use(express.urlencoded({ extended: true}));

app.post('/test-url', (req, res) => {
    console.log(req.body)
    return res.send("went well")
})

app.listen(3000, () => {
    console.log("running on port 3000")
})

G
Gerardo Bautista

in Express 4, it's really simple

const app = express()
const p = process.env.PORT || 8082

app.use(express.json()) 

M
Masiar

This occured to me today. None of above solutions work for me. But a little googling helped me to solve this issue. I'm coding for wechat 3rd party server.

Things get slightly more complicated when your node.js application requires reading streaming POST data, such as a request from a REST client. In this case, the request's property "readable" will be set to true and the POST data must be read in chunks in order to collect all content.

http://www.primaryobjects.com/CMS/Article144


the post mentions HTML form submission as different from REST Client request. aren't both http request ? so, POST is the only case which requires streaming ?
M
Manohar Reddy Poreddy

Wasted a lot of time:

Depending on Content-Type in your client request the server should have different, one of the below app.use():

app.use(bodyParser.text({ type: 'text/html' }))
app.use(bodyParser.text({ type: 'text/xml' }))
app.use(bodyParser.raw({ type: 'application/vnd.custom-type' }))
app.use(bodyParser.json({ type: 'application/*+json' }))

Source: https://www.npmjs.com/package/body-parser#bodyparsertextoptions

Example:

For me, On Client side, I had below header:

Content-Type: "text/xml"

So, on the server side, I used:

app.use(bodyParser.text({type: 'text/xml'}));

Then, req.body worked fine.


H
HenioJR

To work, you need to app.use(app.router) after app.use(express.bodyParser()), like that:

app.use(express.bodyParser())
   .use(express.methodOverride())
   .use(app.router);

Your comment and code snippet are contradictory. First you say you have to use app.use on app.router before express.bodyParser but your code clearly indicates it's AFTER. So which is it?
Sorry man. You need to use app.router after express.bodyParser.
i
isdot
var bodyParser = require('body-parser');
app.use(bodyParser.json());

This saved my day.


K
Kkkk Kkkk

I solved it with:

app.post('/', bodyParser.json(), (req, res) => {//we have req.body JSON
});

M
Mo.

In my case, it was because of using body-parser after including the routes.

The correct code should be

app.use(bodyParser.urlencoded({extended:true}));
app.use(methodOverride("_method"));
app.use(indexRoutes);
app.use(userRoutes);
app.use(adminRoutes);

R
Rafael Fernando Fiedler

Firsl of all, ensure you are applying this middleware (express.urlencoded) before routes.

let app = express();

//response as Json
app.use(express.json()); 

//Parse x-www-form-urlencoded request into req.body
app.use(express.urlencoded({ extended: true }));     

app.post('/test',(req,res)=>{
    res.json(req.body);
});

The code express.urlencoded({extended:true}) only responds to x-www-form-urlencoded posts requests, so in your ajax/XMLHttpRequest/fetch, make sure you are sending the request.setRequestHeader('Content-type', 'application/x-www-form-urlencoded'); header.

Thats it !


this helps a lot. i tried form-data and it always turned out undefined. x-www.form-urlencoded works great.
I
Inc33

If you are using some external tool to make the request, make sure to add the header:

Content-Type: application/json


This one helped me, i was working with Postman, thanks buddy.
I
Inamur Rahman

This is also one possibility: Make Sure that you should write this code before the route in your app.js(or index.js) file.

app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());

A
Arindam

This issue may be because you have not use body-parser (link)

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

var app = express();
app.use(bodyParser.json());

关注公众号,不定期副业成功案例分享
Follow WeChat

Success story sharing

Want to stay one step ahead of the latest teleworks?

Subscribe Now