Why REST design principles matter in Node.js - See It in Action

Why REST Design Principles Matter

📖 Scenario: You are building a simple Node.js server that follows REST design principles to manage a list of books. This server will help clients get book data in a clear and predictable way.

🎯 Goal: Create a basic RESTful API using Node.js that handles book data with proper REST design principles like using correct HTTP methods and clear URL paths.

📋 What You'll Learn

Create an array called books with three book objects, each having id, title, and author properties

Create a variable called port set to 3000

Create a GET route /books that returns the list of books

Create a POST route /books that adds a new book to the books array

💡 Why This Matters

🌍 Real World

REST APIs are used everywhere to let different software talk to each other clearly and predictably, like mobile apps getting data from servers.

💼 Career

Understanding REST design principles is essential for backend developers and full-stack developers to build APIs that others can easily use and maintain.

1

DATA SETUP: Create the initial books array

Create an array called books with these exact three objects: { id: 1, title: '1984', author: 'George Orwell' }, { id: 2, title: 'To Kill a Mockingbird', author: 'Harper Lee' }, and { id: 3, title: 'The Great Gatsby', author: 'F. Scott Fitzgerald' }.

Node.js

// Your code here

Hint

Use const books = [ ... ] with three objects inside.

2

CONFIGURATION: Set the server port

Create a variable called port and set it to 3000.

Node.js

const books = [
  { id: 1, title: '1984', author: 'George Orwell' },
  { id: 2, title: 'To Kill a Mockingbird', author: 'Harper Lee' },
  { id: 3, title: 'The Great Gatsby', author: 'F. Scott Fitzgerald' }
];

// Your code here

Hint

Use const port = 3000; to set the port.

3

CORE LOGIC: Create a GET route to return books

Using Express, create a GET route at /books that sends the books array as JSON response. Use app.get('/books', (req, res) => { ... }) and res.json(books) inside the route.

Node.js

const books = [
  { id: 1, title: '1984', author: 'George Orwell' },
  { id: 2, title: 'To Kill a Mockingbird', author: 'Harper Lee' },
  { id: 3, title: 'The Great Gatsby', author: 'F. Scott Fitzgerald' }
];

const port = 3000;

const express = require('express');
const app = express();
app.use(express.json());

// Your code here

Hint

Use app.get('/books', (req, res) => { res.json(books); }) to create the GET route.

4

COMPLETION: Create a POST route to add a new book

Create a POST route at /books using app.post('/books', (req, res) => { ... }). Inside, add the new book from req.body to the books array, then respond with the added book using res.status(201).json(newBook). Finally, start the server with app.listen(port).

Node.js

const books = [
  { id: 1, title: '1984', author: 'George Orwell' },
  { id: 2, title: 'To Kill a Mockingbird', author: 'Harper Lee' },
  { id: 3, title: 'The Great Gatsby', author: 'F. Scott Fitzgerald' }
];

const port = 3000;

const express = require('express');
const app = express();
app.use(express.json());

app.get('/books', (req, res) => {
  res.json(books);
});

// Your code here

Hint

Use app.post('/books', (req, res) => { ... }) to add the book and app.listen(port) to start the server.

Practice

1. Why is it important to follow REST design principles when building APIs in Node.js?

easy

A. They make APIs easier to understand and use by following clear rules.

B. They force the use of only one HTTP method for all actions.

C. They require APIs to use XML instead of JSON.

D. They allow APIs to ignore URL structure and focus on data only.

Solution

1. Step 1: Understand REST principles purpose

   REST principles guide API design to be clear and predictable by using standard HTTP methods and resource URLs.

2. Step 2: Evaluate options against REST goals

   They make APIs easier to understand and use by following clear rules. matches the goal of making APIs easier to understand and use. The other options contradict REST principles.

3. Final Answer:

   They make APIs easier to understand and use by following clear rules. -> Option A

4. Quick Check:

   REST clarity = A [OK]

Hint: REST means clear rules for APIs, not forcing one method [OK]

Common Mistakes:

• Thinking REST requires only one HTTP method
• Confusing REST with data format rules
• Ignoring URL structure importance

2. Which HTTP method is correctly paired with its RESTful action in Node.js API design?

easy

A. GET to create a new resource

B. PUT to update an existing resource

C. POST to retrieve data

D. DELETE to fetch resource details

Solution

1. Step 1: Recall REST HTTP method meanings

   GET retrieves data, POST creates, PUT updates, DELETE removes resources.

2. Step 2: Match methods to actions

   PUT to update an existing resource correctly pairs PUT with updating a resource. Other options mismatch methods and actions.

3. Final Answer:

   PUT to update an existing resource -> Option B

4. Quick Check:

   PUT = update [OK]

Hint: PUT updates, POST creates, GET reads, DELETE removes [OK]

Common Mistakes:

• Mixing POST and GET actions
• Using DELETE to fetch data
• Confusing PUT with POST

3. Consider this Node.js Express route:

app.delete('/users/:id', (req, res) => {
  // delete user logic
  res.send('User deleted');
});

What is the expected behavior when a client sends a DELETE request to /users/123?

medium

A. It retrieves user 123's details.

B. It updates user 123's information.

C. It deletes user 123 and responds with confirmation.

D. It creates a new user with ID 123.

Solution

1. Step 1: Analyze the HTTP method and route

   The route uses DELETE method on '/users/:id', indicating deletion of a user by ID.

2. Step 2: Understand the response

   The handler sends 'User deleted' after deletion logic, confirming the user is deleted.

3. Final Answer:

   It deletes user 123 and responds with confirmation. -> Option C

4. Quick Check:

   DELETE /users/:id = delete user [OK]

Hint: DELETE routes remove resources and confirm action [OK]

Common Mistakes:

• Confusing DELETE with GET or POST
• Expecting data retrieval on DELETE
• Ignoring route parameter usage

4. You wrote this Node.js Express route:

app.post('/items/:id', (req, res) => {
  // update item logic
  res.send('Item updated');
});

What is the main REST design issue with this code?

medium

A. POST should not be used to update an existing resource; PUT is preferred.

B. The route URL should not include an ID parameter.

C. The response message should be 'Item created' instead.

D. POST cannot have a request body in REST.

Solution

1. Step 1: Identify HTTP method and action mismatch

   POST is typically used to create new resources, not update existing ones.

2. Step 2: Apply REST principle for updating

   PUT is the correct method to update a resource identified by an ID in the URL.

3. Final Answer:

   POST should not be used to update an existing resource; PUT is preferred. -> Option A

4. Quick Check:

   Update = PUT, not POST [OK]

Hint: Use PUT to update existing resources, not POST [OK]

Common Mistakes:

• Using POST for updates
• Ignoring URL parameter meaning
• Confusing response messages with method purpose

5. You want to design a RESTful API in Node.js to manage books. Which URL and HTTP method combination best follows REST principles to update the title of a book with ID 42?

hard

A. POST /books/42 with new title in body

B. GET /books/update/42 with new title in query

C. DELETE /books/42 with new title in body

D. PUT /books/42 with new title in body

Solution

1. Step 1: Identify RESTful update method

   PUT is the standard HTTP method to update an existing resource fully or partially.

2. Step 2: Check URL structure for resource identification

   /books/42 correctly identifies the book resource by ID, matching REST URL design.

3. Step 3: Evaluate other options

   POST is for creation, GET should not change data, DELETE removes resource, so they are incorrect here.

4. Final Answer:

   PUT /books/42 with new title in body -> Option D

5. Quick Check:

   Update book = PUT /books/42 [OK]

Hint: Use PUT with resource URL to update data [OK]

Common Mistakes:

• Using POST to update existing resource
• Using GET to change data
• Misusing DELETE for updates