What are express.json() and express.urlencoded()?
Here is the explanation that should clear doubts on express.json()
and express.urlencoded()
and the use of body-parser. It took me some time to figure this out.
What is Middleware? It is those methods/functions/operations that are called BETWEEN processing the Request and sending the Response in your application method.
When talking about
express.json()
andexpress.urlencoded()
think specifically about POST requests (i.e. the .post request object) and PUT Requests (i.e. the .put request object)You DO NOT NEED
express.json()
andexpress.urlencoded()
for GET Requests or DELETE Requests.You NEED
express.json()
andexpress.urlencoded()
for POST and PUT requests, because in both these requests you are sending data (in the form of some data object) to the server and you are asking the server to accept or store that data (object), which is enclosed in the body (i.e.req.body
) of that (POST or PUT) RequestExpress provides you with middleware to deal with the (incoming) data (object) in the body of the request.
a.
express.json()
is a method inbuilt in express to recognize the incoming Request Object as a JSON Object. This method is called as a middleware in your application using the code:app.use(express.json());
b.
express.urlencoded()
is a method inbuilt in express to recognize the incoming Request Object as strings or arrays. This method is called as a middleware in your application using the code:app.use(express.urlencoded());
ALTERNATIVELY, I recommend using body-parser (it is an NPM package) to do the same thing. It is developed by the same peeps who built express and is designed to work with express. body-parser used to be part of express. Think of body-parser specifically for POST Requests (i.e. the .post request object) and/or PUT Requests (i.e. the .put request object).
In body-parser you can do
// calling body-parser to handle the Request Object from POST requests var bodyParser = require('body-parser'); // parse application/json, basically parse incoming Request Object as a JSON Object app.use(bodyParser.json()); // parse application/x-www-form-urlencoded, basically can only parse incoming Request Object if strings or arrays app.use(bodyParser.urlencoded({ extended: false })); // combines the 2 above, then you can parse incoming Request Object if object, with nested objects, or generally any type. app.use(bodyParser.urlencoded({ extended: true }));
The json
and urlencoded
middleware are both part of bodyParser. This is what the README says:
bodyParser([options])
Returns middleware that parses both
json
andurlencoded
. Theoptions
are passed to both middleware.bodyParser.json([options])
Returns middleware that only parses
json
. The options are:
strict
- only parse objects and arrayslimit
<1mb> - maximum request body sizereviver
- passed toJSON.parse()
bodyParser.urlencoded([options])
Returns middleware that only parses
urlencoded
with the qs module. The options are:
limit
<1mb> - maximum request body size