Step-by-Step RESTful API Development with Express.js

RESTful APIs, which developers frequently resort to for web applications, offer a standard and rule-based structure to make data management easier. In this article, we will focus on the process of developing a RESTful API using the Express.js framework. Express.js is a fast and minimalist web application framework written with Node.js, which makes API development very easy and fast.

What is Express.js and Why is it Used?

Express.js is a web application framework running on Node.js. It is an ideal choice for developing RESTful APIs because, in addition to being very lightweight and providing high performance, it offers many advantages such as being enriched with various middleware and modules. With Express.js, it is quite simple to respond to HTTP requests, perform routing operations, and handle errors.

Steps to Develop a RESTful API

1. Creating the Project

As the first step, you should create a new Node.js project. You can start the project by typing the following commands in the terminal or command prompt:

mkdir my-api
cd my-api
npm init -y

2. Installing the Required Packages

You can use the following command to install Express.js and other required packages:

npm install express body-parser cors

3. Basic Server Setup

Now, let’s create a basic Express.js server. Create a file named app.js and add the following code:

const express = require('express');
const bodyParser = require('body-parser');
const cors = require('cors');

const app = express();
const PORT = 3000;

app.use(cors());
app.use(bodyParser.json());

app.get('/', (req, res) => {
    res.send('RESTful API is running!');
});

app.listen(PORT, () => {
    console.log(`Server is running on port ${PORT}`);
});

4. Adding CRUD Operations

Now, let’s see how to add basic CRUD (Create, Read, Update, Delete) operations. You can perform these operations with an example user array below:

let users = [];

app.post('/users', (req, res) => {
    const user = req.body;
    users.push(user);
    res.status(201).send(user);
});

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

app.put('/users/:id', (req, res) => {
    const userId = req.params.id;
    const userIndex = users.findIndex(user => user.id === userId);
    if (userIndex !== -1) {
        users[userIndex] = req.body;
        res.send(users[userIndex]);
    } else {
        res.status(404).send('User not found.');
    }
});

app.delete('/users/:id', (req, res) => {
    const userId = req.params.id;
    users = users.filter(user => user.id !== userId);
    res.status(204).send();
});

Conclusion

By following the steps above, we have developed a simple RESTful API. Creating an API with Express.js greatly facilitates data management and interaction between client and server. Starting from this basic setup, you can continue to develop your API with more complex applications and database integrations. Express.js is frequently preferred in modern web development processes for its flexibility and performance.