A Beginner’s Guide to Designing RESTful APIs in Node.js

Suraj Sundar — Fri, 23 May 2025 16:04:27 +0000

Building scalable and maintainable APIs is a vital skill for developers in today’s software ecosystem. If you’re just starting out and wondering how to design backend APIs using Node.js and Express.js, this guide is for you.

We’ll walk through core concepts, folder structure and the reasoning behind architectural decisions — without overwhelming you with complexity.
🚀 Why Backend API Design Matters

Well-designed APIs are:
✅ Easy to understand and use
✅ Consistent and predictable
✅ Scalable as your application grows
✅ Simple to test and document

As beginners, the goal isn’t to build a massive system, but to learn how to structure clean, scalable APIs.
🛠️ Tools We’ll Use

Node.js — JavaScript runtime
Express.js — Web framework for APIs
Optional (for later scaling):
MongoDB / Postgres — For storing data
🗂️ Recommended Folder Structure

A clear project structure helps scalability and collaboration.

backend/ ├── controllers/ # Logic for routes │ └── userController.js ├── routes/ # API route definitions │ └── userRoutes.js ├── app.js # Main server file └── package.json

Why this structure?

Keeping route definitions and business logic in separate files makes your project easier to maintain and scale.
🧩 Why Use Controllers?

As your project grows, putting all logic inside routes becomes messy.
Separate controllers help organize the logic:

// controllers/userController.js
export const getUsers = (req, res) => {
 // logic here
};

export const addUser = (req, res) => {
 // logic here
};

Then in your route file:

import express from ‘express’;
import { getUsers, addUser } from ‘../controllers/userController.js’;

const router = express.Router();

router.get('/', getUsers);
router.post('/', addUser);

export default router;

✅ A Typical Beginner-Friendly Flow

Let’s say we want to:

GET a list of users
POST a new user

// routes/userRoutes.js
router.get(‘/’, getUsers);
router.post(‘/’, addUser);

// controllers/userController.js
let users = [{ id: 1, name: ‘Suraj’ }];

// getUsers
export const getUsers = (req, res) => {
 try {
 res.status(200).json(users);
 } catch {
 res.status(500).json({ message: 'Server error' });
 }
};

// addUser
export const addUser = (req, res) => {
 try {
 const { name } = req.body;
 const newUser = { id: users.length + 1, name };
 users.push(newUser);
 res.status(201).json({ message: 'User created', user: newUser });
 } catch {
 res.status(500).json({ message: 'Failed to add user' });
 }
};

🌱 How to Scale This Later?

✅ Add database support (e.g., MongoDB, PostgreSQL)
✅ Integrate authentication (JWT, OAuth)
✅ Add middleware for validation, logging, etc.
✅ Implement unit testing
✅ Use dotenv for config and secrets
✨ Final Thoughts

Your first API doesn’t need to be perfect. But with a clean structure, consistent practices, and documentation, you’ll be miles ahead.
Key Takeaways:

Use controllers for logic
Follow REST principles
Document your API
Keep code organized

If you found this helpful, share it with others or drop a comment! 🚀

Control an Arduino LED with a MERN Web App – A Beginner’s IoT Project

Suraj Sundar — Sat, 29 Mar 2025 14:29:03 +0000

Introduction

As a tech enthusiast, I’ve always been fascinated by the power of the Internet of Things (IoT)—the way physical devices can seamlessly interact with the digital world. Recently, while learning the MERN stack, I was eager to explore how IoT can integrate with web technologies.

In this beginner-friendly project, I’ll walk through connecting an Arduino UNO board to a web app to control an LED remotely. This project demonstrates a two-way communication system:

✅ The user interacts with a web app to turn an LED on/off.✅ The real-time status of the LED is displayed in the web app for instant feedback.

Note: At this stage, I’m not using MongoDB (keeping it simple), focusing instead on establishing a basic connection between an IoT device and a web application.

🔌 Hardware Setup
1️⃣ Set Up the Arduino UNO

Connect the Arduino UNO to your computer via USB.
Install and open the Arduino IDE.
Select the correct port for the Arduino in the Tools → Port section.

2️⃣ Connect the LED to Arduino

Use a digital output pin (e.g., Pin 13) to control the LED.
Connect the longer leg (anode) of the LED to Pin 13.
Connect the shorter leg (cathode) to GND.
Use a resistor (330Ω) in series to prevent excess current.

3️⃣ Ensure Proper Power Supply

The Arduino will be powered via USB, so no external power supply is needed.

🖥️ Software Integration
🔹 Backend Setup (Node.js & Express)

Set up a Node.js project and install Express to create a simple web server.
Use the serialport library to communicate with the Arduino via the serial port.
Define a /led route in the Express server to handle LED control requests.
The backend sends ON/OFF commands to the Arduino based on user input.

🔹 Upload Arduino Code

Write and upload Arduino code to listen for serial commands (ON/OFF) and control the LED accordingly.

🔹 Frontend Setup (React & Axios)

Create a simple React app with buttons to turn the LED ON/OFF.
Use Axios to send POST requests to the backend.
Display the current LED status in the frontend based on backend responses.

📡 How It Works

1️⃣ User clicks ON/OFF button in the web app.
2️⃣ A request is sent to the backend server.
3️⃣ The server sends a command to the Arduino via serial communication.
4️⃣ Arduino receives the command and controls the LED accordingly.
5️⃣ The web app updates the LED status based on the response.

🎬 Demo Video & Code

📽 Demo Video
💻 GitHub Repository
📝 Medium Blog

DEV Community: Suraj Sundar

A Beginner’s Guide to Designing RESTful APIs in Node.js

Control an Arduino LED with a MERN Web App – A Beginner’s IoT Project