Node.js HTTP Module

Last modified on: October 24, 2024

<div class="flex-shrink-0 flex flex-col relative items-end">
<div>
<div class="pt-0">
<div class="gizmo-bot-avatar flex h-8 w-8 items-center justify-center overflow-hidden rounded-full">
<div class="relative p-1 rounded-sm flex items-center justify-center bg-token-main-surface-primary text-token-text-primary h-8 w-8">&nbsp;</div>
</div>
</div>
</div>
</div>
<div class="group/conversation-turn relative flex w-full min-w-0 flex-col agent-turn">
<div class="flex-col gap-1 md:gap-3">
<div class="flex max-w-full flex-col flex-grow">
<div class="min-h-8 text-message flex w-full flex-col items-end gap-2 whitespace-normal break-words [.text-message+&amp;]:mt-5" dir="auto" data-message-author-role="assistant" data-message-id="bf41d0a3-e81a-4ec4-b126-ad26951db0ae" data-message-model-slug="gpt-4o-mini">
<div class="flex w-full flex-col gap-1 empty:hidden first:pt-[3px]">
<div class="markdown prose w-full break-words dark:prose-invert light">
<h3>Node.js HTTP Module: A Comprehensive Guide</h3>
<p>The <strong>HTTP module</strong> in Node.js is a built-in module that allows you to create HTTP servers and clients. It provides a powerful set of tools for handling HTTP requests and responses, making it essential for building web applications and APIs. This guide will cover the basics of the HTTP module, how to create a simple HTTP server, handle routing, and work with HTTP requests and responses.</p>
<hr />
<h3>What is the HTTP Module?</h3>
<p>The HTTP module is part of Node.js's core modules and provides functionality for both creating servers and sending requests to external resources. It abstracts the complexities of HTTP protocol, enabling developers to handle HTTP requests and responses easily.</p>
<h4>Key Features of the HTTP Module:</h4>
<ul>
<li><strong>Create HTTP Servers</strong>: Allows you to create web servers that can listen for requests and respond accordingly.</li>
<li><strong>Handle Requests and Responses</strong>: Provides methods to work with incoming requests and outgoing responses.</li>
<li><strong>Support for HTTP/HTTPS</strong>: Can be used for both HTTP and HTTPS servers.</li>
<li><strong>Stream Interface</strong>: Uses streams to handle data efficiently, enabling non-blocking I/O operations.</li>
</ul>
<hr />
<h3>Setting Up an HTTP Server</h3>
<p>Let's start by creating a simple HTTP server using the HTTP module.</p>
<h4>Step 1: Create a New Project</h4>
<ol>
<li>
<p>Create a new directory for your project:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">bash</div>
<div class="sticky top-9 md:top-[5.75rem]">
<div class="absolute bottom-0 right-2 flex h-9 items-center">
<div class="flex items-center rounded bg-token-main-surface-secondary px-2 font-sans text-xs text-token-text-secondary">
<pre class="language-javascript"><code>mkdir http-server-example
cd http-server-example</code></pre>
</div>
</div>
</div>
</div>
</li>
<li>
<p>Initialize a new Node.js project:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">bash</div>
<div class="sticky top-9 md:top-[5.75rem]">
<div class="absolute bottom-0 right-2 flex h-9 items-center">
<div class="flex items-center rounded bg-token-main-surface-secondary px-2 font-sans text-xs text-token-text-secondary">
<pre class="language-javascript"><code>npm init -y</code></pre>
</div>
</div>
</div>
</div>
</li>
</ol>
<h4>Step 2: Create the Server</h4>
<ol>
<li>Create a file named <code>server.js</code> and open it in your favorite text editor.</li>
<li>Add the following code to create a basic HTTP server:</li>
</ol>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">javascript</div>
<div class="sticky top-9 md:top-[5.75rem]">
<div class="absolute bottom-0 right-2 flex h-9 items-center">
<div class="flex items-center rounded bg-token-main-surface-secondary px-2 font-sans text-xs text-token-text-secondary">
<pre class="language-javascript"><code>// Load the HTTP module
const http = require('http');

// Create the server
const server = http.createServer((req, res) =&gt; {
    // Set the response HTTP header with HTTP status and content type
    res.writeHead(200, { 'Content-Type': 'text/plain' });
    
    // Send the response body
    res.end('Hello, World from the HTTP module!\n');
});

// Server listens on port 3000
server.listen(3000, () =&gt; {
    console.log('Server running at http://localhost:3000/');
});</code></pre>
</div>
</div>
</div>
</div>
<h4>Step 3: Run the Server</h4>
<p>In your terminal, run the server with the following command:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">bash</div>
<div class="sticky top-9 md:top-[5.75rem]">
<div class="absolute bottom-0 right-2 flex h-9 items-center">
<div class="flex items-center rounded bg-token-main-surface-secondary px-2 font-sans text-xs text-token-text-secondary">
<pre class="language-javascript"><code>node server.js</code></pre>
</div>
</div>
</div>
</div>
<p>You should see the output:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="sticky top-9 md:top-[5.75rem]">
<div class="absolute bottom-0 right-2 flex h-9 items-center">
<div class="flex items-center rounded bg-token-main-surface-secondary px-2 font-sans text-xs text-token-text-secondary">
<pre class="language-javascript"><code>Server running at http://localhost:3000/</code></pre>
</div>
</div>
</div>
</div>
<h4>Step 4: Test the Server</h4>
<p>Open your web browser and navigate to <code>http://localhost:3000/</code>. You should see the message:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">javascript</div>
<div class="sticky top-9 md:top-[5.75rem]">
<div class="absolute bottom-0 right-2 flex h-9 items-center">
<div class="flex items-center rounded bg-token-main-surface-secondary px-2 font-sans text-xs text-token-text-secondary">
<pre class="language-javascript"><code>Hello, World from the HTTP module!</code></pre>
</div>
</div>
</div>
</div>
<hr />
<h3>Handling HTTP Requests</h3>
<p>You can handle different HTTP requests (GET, POST, etc.) and route them accordingly.</p>
<h4>Example: Handling GET and POST Requests</h4>
<p>Modify your <code>server.js</code> file to handle both GET and POST requests:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">javascript</div>
<div class="sticky top-9 md:top-[5.75rem]">
<div class="absolute bottom-0 right-2 flex h-9 items-center">
<div class="flex items-center rounded bg-token-main-surface-secondary px-2 font-sans text-xs text-token-text-secondary">
<pre class="language-javascript"><code>const http = require('http');

// Create the server
const server = http.createServer((req, res) =&gt; {
    // Handle GET requests
    if (req.method === 'GET') {
        res.writeHead(200, { 'Content-Type': 'text/plain' });
        res.end('This is a GET request.\n');
    }
    // Handle POST requests
    else if (req.method === 'POST') {
        res.writeHead(200, { 'Content-Type': 'text/plain' });
        res.end('This is a POST request.\n');
    } else {
        // Handle other request types
        res.writeHead(405, { 'Content-Type': 'text/plain' });
        res.end('Method Not Allowed\n');
    }
});

// Server listens on port 3000
server.listen(3000, () =&gt; {
    console.log('Server running at http://localhost:3000/');
});</code></pre>
</div>
</div>
</div>
</div>
<h4>Step 5: Test GET and POST Requests</h4>
<ol>
<li>
<p>Open your browser and navigate to <code>http://localhost:3000/</code> to test the GET request. You should see the message:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="sticky top-9 md:top-[5.75rem]">
<div class="absolute bottom-0 right-2 flex h-9 items-center">
<div class="flex items-center rounded bg-token-main-surface-secondary px-2 font-sans text-xs text-token-text-secondary">
<pre class="language-javascript"><code>This is a GET request.</code></pre>
</div>
</div>
</div>
</div>
</li>
<li>
<p>To test the POST request, you can use a tool like <strong>Postman</strong> or <strong>curl</strong>. For example, using <code>curl</code> in the terminal:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">bash</div>
<div class="sticky top-9 md:top-[5.75rem]">
<div class="absolute bottom-0 right-2 flex h-9 items-center">
<div class="flex items-center rounded bg-token-main-surface-secondary px-2 font-sans text-xs text-token-text-secondary">
<pre class="language-javascript"><code>curl -X POST http://localhost:3000/</code></pre>
</div>
</div>
</div>
</div>
</li>
</ol>
<p>You should see the message:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">
<pre class="language-javascript"><code>This is a POST request.</code></pre>
</div>
</div>
<hr />
<h3>Routing Requests</h3>
<p>For a more structured approach, you can implement basic routing based on the URL of incoming requests.</p>
<h4>Example: Basic Routing</h4>
<p>Modify your server to handle different routes:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">javascript</div>
<div class="sticky top-9 md:top-[5.75rem]">
<div class="absolute bottom-0 right-2 flex h-9 items-center">
<div class="flex items-center rounded bg-token-main-surface-secondary px-2 font-sans text-xs text-token-text-secondary">
<pre class="language-javascript"><code>const http = require('http');

// Create the server
const server = http.createServer((req, res) =&gt; {
    // Handle routing based on the URL
    if (req.method === 'GET') {
        if (req.url === '/') {
            res.writeHead(200, { 'Content-Type': 'text/plain' });
            res.end('Welcome to the homepage!\n');
        } else if (req.url === '/about') {
            res.writeHead(200, { 'Content-Type': 'text/plain' });
            res.end('This is the about page.\n');
        } else {
            res.writeHead(404, { 'Content-Type': 'text/plain' });
            res.end('Page not found.\n');
        }
    } else {
        // Handle other request types
        res.writeHead(405, { 'Content-Type': 'text/plain' });
        res.end('Method Not Allowed\n');
    }
});

// Server listens on port 3000
server.listen(3000, () =&gt; {
    console.log('Server running at http://localhost:3000/');
});</code></pre>
</div>
</div>
</div>
</div>
<h4>Step 6: Test the Routes</h4>
<ol>
<li>
<p>Navigate to <code>http://localhost:3000/</code> to see the homepage message:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">
<pre class="language-javascript"><code>Welcome to the homepage!</code></pre>
</div>
</div>
</li>
<li>
<p>Navigate to <code>http://localhost:3000/about</code> to see the about page message:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">
<pre class="language-javascript"><code>This is the about page.</code></pre>
</div>
</div>
</li>
<li>
<p>Navigate to a non-existent page, like <code>http://localhost:3000/contact</code>, to see the 404 error message:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">
<pre class="language-javascript"><code>Page not found.</code></pre>
</div>
</div>
</li>
</ol>
<hr />
<h3>Handling Query Parameters</h3>
<p>You can also handle query parameters in the URL. To parse the URL and extract query parameters, you can use the <code>url</code> module.</p>
<h4>Example: Handling Query Parameters</h4>
<p>Modify your server to read query parameters:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">javascript</div>
<div class="sticky top-9 md:top-[5.75rem]">
<div class="absolute bottom-0 right-2 flex h-9 items-center">
<div class="flex items-center rounded bg-token-main-surface-secondary px-2 font-sans text-xs text-token-text-secondary">&nbsp;</div>
</div>
</div>
</div>
<h4>Step 7: Test Query Parameters</h4>
<ol>
<li>
<p>Navigate to <code>http://localhost:3000/greet?name=Alice</code> to see the greeting message:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">
<pre class="language-javascript"><code>Hello, Alice!</code></pre>
</div>
</div>
</li>
<li>
<p>Navigate to <code>http://localhost:3000/greet</code> to see the default greeting:</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">
<pre class="language-javascript"><code>Hello, World!</code></pre>
</div>
</div>
</li>
</ol>
<hr />
<h3>Conclusion</h3>
<p>The HTTP module in Node.js is a powerful tool for creating web servers and handling HTTP requests. By learning how to use this module effectively, you can build robust web applications and APIs.</p>
<p>In this guide, we covered:</p>
<ul>
<li>Setting up a basic HTTP server.</li>
<li>Handling different types of requests (GET and POST).</li>
<li>Implementing basic routing.</li>
<li>Handling query parameters.</li>
</ul>
<p>With these foundations, you can further explore more advanced features of the HTTP module, integrate middleware using frameworks like Express, and build complex applications.</p>
</div>
</div>
</div>
</div>
</div>
</div>

Web Technology View More