Understanding Request and Response Objects in Express.js

When building web applications with Node.js and Express.js, understanding how to handle incoming requests and craft appropriate responses is fundamental. The

code

request

(often abbreviated as

code

req

) and

code

response

(often abbreviated as

code

res

) objects are the core interfaces for this interaction. They provide access to all the information sent by the client and the methods to send data back.

The Request Object (`req`)

The

code

request

object encapsulates all the information about the incoming HTTP request from the client. This includes details like the URL being accessed, the HTTP method used (GET, POST, PUT, DELETE, etc.), headers sent by the client, query parameters, request body, and even cookies.

The `req` object is your window into what the client is asking for.

It contains details about the client's request, such as the URL, method, headers, and data.

Key properties of the req object include:

req.url: The URL path of the request.
req.method: The HTTP method (e.g., 'GET', 'POST').
req.headers: An object containing the request headers.
req.params: An object containing route parameters (e.g., /users/:id would have req.params.id).
req.query: An object containing URL query string parameters (e.g., /search?q=express).
req.body: The data sent in the request body (often parsed from JSON or form data).
req.cookies: An object containing cookies sent by the client (requires cookie-parsing middleware).
req.ip: The IP address of the client.

The Response Object (`res`)

The

code

response

object is used to send data back to the client. Express provides a rich set of methods on the

code

res

object to control the HTTP response, including setting status codes, headers, and sending the response body.

The `res` object is your tool to communicate back to the client.

It allows you to send data, set status codes, and manage headers for the client's response.

Common methods of the res object include:

res.send(body): Sends the HTTP response. The type of the body determines the Content-Type header.
res.json(body): Sends a JSON response. Sets the Content-Type to application/json.
res.status(statusCode): Sets the HTTP status code (e.g., res.status(200)).
res.sendStatus(statusCode): Sets the response HTTP status code and sends its corresponding text description.
res.render(viewName, [options], [callback]): Renders a view template with data.
res.redirect(url): Redirects the client to a different URL.
res.set(field, [value]): Sets the response header field.
res.cookie(name, value, [options]): Sets a cookie in the response.
res.end([data], [encoding]): Ends the response process.

Putting it Together: A Simple Example

Let's look at a basic Express.js route handler that uses both

code

req

and

code

res

Consider a route that greets a user by name, passed as a URL parameter. The req.params.name will capture the name from the URL, and res.send() will construct the greeting message to send back to the client.

📚

Text-based content

Library pages focus on text content

Loading diagram...

Key Concepts and Best Practices

Always remember that req is for reading incoming data, and res is for writing outgoing data. You should never modify the req object to send a response.

When handling POST or PUT requests, you'll often need to parse the request body. Middleware like

code

express.json()

code

express.urlencoded()

is essential for this, populating

code

req.body

with the data.

Which object property would you use to access a parameter like ':userId' in a route like '/users/:userId'?

req.params.userId

What method on the res object is used to send a JSON response?

res.json()

Learning Resources

Express.js API Documentation - Request(documentation)

The official Express.js documentation detailing all properties and methods of the Request object.

Express.js API Documentation - Response(documentation)

The official Express.js documentation detailing all methods available on the Response object for sending data back to the client.

MDN Web Docs - HTTP Request Headers(documentation)

A comprehensive guide to HTTP request headers, which are accessible via req.headers in Express.

MDN Web Docs - HTTP Response Headers(documentation)

An overview of HTTP response headers, which you can set using methods on the res object.

Node.js HTTP Module - IncomingMessage(documentation)

The underlying Node.js core module documentation for IncomingMessage, which Express's Request object extends.

Node.js HTTP Module - ServerResponse(documentation)

The underlying Node.js core module documentation for ServerResponse, which Express's Response object extends.

Express.js Middleware - Body Parsing(documentation)

Learn about built-in middleware like express.json() and express.urlencoded() for parsing request bodies.

DigitalOcean - How To Build a RESTful API With Node.js, Express, and MongoDB(tutorial)

A practical tutorial that demonstrates building an API, showcasing request and response handling in context.

Academind - Node.js & Express Crash Course(video)

A comprehensive video tutorial covering Node.js and Express, including detailed explanations of request and response objects.

FreeCodeCamp - Node.js Tutorial for Beginners: Learn Node.js In 12 Hours(video)

An extensive beginner-friendly video tutorial on Node.js, with sections dedicated to building web servers and handling requests/responses.