Implementing a Basic CRUD App with Node.js and Express

In the interconnected world of web applications, CRUD (Create, Read, Update, Delete) operations form the backbone of data-driven applications. Leveraging Node.js along with its minimalistic yet powerful framework, Express, allows for setting up a robust REST API that fulfills CRUD functionalities efficiently. This step-by-step guide will walk you through building a basic CRUD application using Node.js and Express from scratch, offering code snippets and practical explanations along the way.

Setting Up Your Node.js Environment

Before diving into code, ensure your development environment is set up correctly. This involves:

node -v
npm -v

If you see version numbers, you’re good to go. Start by creating a new directory for your project and initialize a new Node.js project:

mkdir my-crud-app
cd my-crud-app
npm init -y

This will create a package.json file to manage project dependencies.

Installing and Configuring Express

Next, let’s install Express along with some essential middlewares:

npm install express body-parser

Express will serve as the framework guiding HTTP request handling, while body-parser facilitates parsing JSON data from incoming requests.

In the root directory, create an entry file, typically named server.js, and start by setting up a simple Express server:

const express = require('express');
const bodyParser = require('body-parser');
const app = express();
const port = 3000;

app.use(bodyParser.json());

app.listen(port, () => {
  console.log(`Server running at http://localhost:${port}`);
});

Create: Handling POST Requests

The first CRUD operation we’ll implement is ‘Create’. For simplicity, assume our resource is a collection of simple ‘Item’ objects:

let items = [];
let id = 0;

app.post('/items', (req, res) => {
  const item = {
    id: ++id,
    name: req.body.name
  };
  items.push(item);
  res.status(201).send(item);
});

This code snippet handles POST requests to add a new item to our collection, assigning it a unique ID. On success, it returns the newly created item with a 201 status code.

Read: Implementing GET Requests

Reading data from the server is crucial. Implementing the Read operation involves setting up GET endpoints:

app.get('/items', (req, res) => {
  res.send(items);
});

app.get('/items/:id', (req, res) => {
  const item = items.find(i => i.id === parseInt(req.params.id));
  if (!item) return res.status(404).send('Item not found');
  res.send(item);
});

The first route returns all items, while the second retrieves a single item by its ID, handling cases where the item doesn’t exist.

Update: Enabling PUT Requests

Updating resources involves listening to PUT requests:

app.put('/items/:id', (req, res) => {
  const item = items.find(i => i.id === parseInt(req.params.id));
  if (!item) return res.status(404).send('Item not found');

  item.name = req.body.name;
  res.send(item);
});

Our PUT endpoint checks for the existence of the item, updates the name property, and returns the modified object.

Delete: Processing DELETE Requests

Finally, let’s implement deleting a resource:

app.delete('/items/:id', (req, res) => {
  const item = items.find(i => i.id === parseInt(req.params.id));
  if (!item) return res.status(404).send('Item not found');

  const index = items.indexOf(item);
  items.splice(index, 1);
  res.send(item);
});

The DELETE endpoint verifies the existence of the item, removes it from the list, and acknowledges the operation by returning the deleted item.

Conclusion

You have now constructed a basic CRUD application using Node.js and Express, with HTTP methods supporting fundamental operations. This example can serve as a solid foundation, easily extendable to work with databases for persistent storage or integrated with front-end frameworks for building interactive applications.

Useful links: