Resource-based route organization in Express - Mini Project: Build & Apply

Resource-based route organization in Express

📖 Scenario: You are building a simple web server for a bookstore. You want to organize your routes by resource type to keep your code clean and easy to maintain.

🎯 Goal: Create an Express app that organizes routes for the books resource using resource-based route organization. You will set up the initial data, configure a router, add core route handlers, and complete the app to listen on a port.

📋 What You'll Learn

Create an Express app with a books array containing book objects

Create a router for books routes

Add GET route handlers for /books and /books/:id

Make the app use the books router under the /books path

Start the server listening on port 3000

💡 Why This Matters

🌍 Real World

Organizing routes by resource helps keep server code clean and maintainable, especially as projects grow.

💼 Career

Understanding Express routers and resource-based route organization is essential for backend web development jobs using Node.js.

1

Set up initial data and Express app

Create an Express app by requiring express and calling express(). Then create a books array with these exact objects: { id: 1, title: '1984' }, { id: 2, title: 'Brave New World' }, and { id: 3, title: 'Fahrenheit 451' }.

Express

const express = require('express');
const app = express();

// Your code here

Hint

Remember to require Express and call it to create your app. Then create the books array with the exact objects.

2

Create a router for books

Create a router by calling express.Router() and assign it to a variable called booksRouter.

Express

const express = require('express');
const app = express();

const books = [
  { id: 1, title: '1984' },
  { id: 2, title: 'Brave New World' },
  { id: 3, title: 'Fahrenheit 451' }
];

// Your code here

Hint

Use express.Router() to create a router for the books resource.

3

Add GET routes to the books router

Add a GET route handler on booksRouter for path '/' that sends the full books array as JSON. Also add a GET route handler on booksRouter for path '/:id' that finds a book by id from books and sends it as JSON. Use req.params.id and convert it to a number to find the book.

Express

const express = require('express');
const app = express();

const books = [
  { id: 1, title: '1984' },
  { id: 2, title: 'Brave New World' },
  { id: 3, title: 'Fahrenheit 451' }
];

const booksRouter = express.Router();

// Your code here

Hint

Use booksRouter.get to add route handlers. Use res.json() to send JSON responses.

4

Use the router and start the server

Make the Express app use booksRouter for the path '/books' by calling app.use('/books', booksRouter). Then start the server listening on port 3000 using app.listen(3000).

Express

const express = require('express');
const app = express();

const books = [
  { id: 1, title: '1984' },
  { id: 2, title: 'Brave New World' },
  { id: 3, title: 'Fahrenheit 451' }
];

const booksRouter = express.Router();

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

booksRouter.get('/:id', (req, res) => {
  const id = Number(req.params.id);
  const book = books.find(b => b.id === id);
  res.json(book);
});

// Your code here

Hint

Use app.use to connect the router and app.listen to start the server.

Practice

1. What is the main benefit of organizing routes by resource in an Express app?

easy

A. It groups related routes together for better code organization.

B. It automatically generates HTML pages for each resource.

C. It prevents users from accessing the API without a password.

D. It makes the server run faster by caching routes.

Solution

1. Step 1: Understand resource-based route organization

   Resource-based organization groups routes by the data or resource they manage, like users or products.

2. Step 2: Identify the main benefit

   This grouping helps keep code modular and easier to maintain by keeping related routes together.

3. Final Answer:

   It groups related routes together for better code organization. -> Option A

4. Quick Check:

   Grouping routes by resource = better organization [OK]

Hint: Think about grouping similar things together for neatness [OK]

Common Mistakes:

• Confusing route grouping with security features
• Assuming route organization affects server speed
• Thinking routes auto-generate HTML pages

2. Which of the following is the correct way to create a router for a resource named books in Express?

easy

A. const booksRouter = new express.Router();

B. const booksRouter = express.createRouter();

C. const booksRouter = express.Router();

D. const booksRouter = express.route('books');

Solution

1. Step 1: Recall Express Router creation syntax

   Express provides a Router() method on the express object to create modular route handlers.

2. Step 2: Match the correct syntax

   The correct syntax is express.Router(), not createRouter() or new express.Router().

3. Final Answer:

   const booksRouter = express.Router(); -> Option C

4. Quick Check:

   Use express.Router() to create routers [OK]

Hint: Remember: Router is a method, not a constructor or create function [OK]

Common Mistakes:

• Using new keyword with Router
• Calling a non-existent createRouter method
• Using express.route instead of express.Router

3. Given this Express router code for a users resource:

const express = require('express');
const router = express.Router();

router.get('/', (req, res) => res.send('List users'));
router.post('/', (req, res) => res.send('Create user'));
router.get('/:id', (req, res) => res.send(`Get user ${req.params.id}`));

module.exports = router;

What will be the response when a client sends a GET request to /users/42?

medium

A. List users

B. Get user 42

C. 404 Not Found

D. Create user

Solution

1. Step 1: Identify the matching route for GET /users/42

   The route router.get('/:id', ...) matches GET requests with a parameter after /users/.

2. Step 2: Understand the response sent

   The handler sends back the string Get user 42 using the id parameter from the URL.

3. Final Answer:

   Get user 42 -> Option B

4. Quick Check:

   GET /users/:id returns 'Get user {id}' [OK]

Hint: Match URL pattern with route parameters carefully [OK]

Common Mistakes:

• Confusing POST and GET routes
• Ignoring route parameters in URL
• Assuming root path '/' matches /users/42

4. Consider this Express router code snippet:

const router = express.Router();

router.get('/items', (req, res) => res.send('All items'));
router.get('/items/:id', (req, res) => res.send(`Item ${req.params.id}`));
router.post('/items', (req, res) => res.send('Add item'));

module.exports = router;

When mounting this router in the main app with app.use('/api', router);, what is the correct URL to get the response 'Item 5'?

medium

A. /api/items/5

B. /items/5

C. /api/items

D. /items

Solution

1. Step 1: Understand router mounting path

   The router is mounted at /api, so all routes inside it are prefixed with /api.

2. Step 2: Match the route for getting item with id 5

   The route /items/:id inside the router becomes /api/items/:id in the app.

3. Final Answer:

   /api/items/5 -> Option A

4. Quick Check:

   Router prefix + route path = full URL [OK]

Hint: Add router prefix before route path when calling URLs [OK]

Common Mistakes:

• Ignoring the router prefix when calling URLs
• Using root path instead of mounted path
• Confusing POST and GET URLs

5. You want to organize routes for a products resource using Express Router. You need to support listing all products, creating a product, getting a product by ID, updating a product by ID, and deleting a product by ID.

Which of the following router setups correctly implements all these routes following resource-based route organization?

hard

A. const router = express.Router();
router.get('/products', ...);
router.post('/products', ...);
router.get('/products/:id', ...);
router.put('/products/:id', ...);
router.delete('/products/:id', ...);

B. const router = express.Router();
router.get('/list', ...);
router.post('/create', ...);
router.get('/get/:id', ...);
router.put('/update/:id', ...);
router.delete('/delete/:id', ...);

C. const router = express.Router();
router.get('/products/all', ...);
router.post('/products/new', ...);
router.get('/products/get/:id', ...);
router.put('/products/update/:id', ...);
router.delete('/products/remove/:id', ...);

D. const router = express.Router();
router.get('/', ...);
router.post('/', ...);
router.get('/:id', ...);
router.put('/:id', ...);
router.delete('/:id', ...);

Solution

1. Step 1: Understand resource-based route organization with routers

   When using Express Router for a resource, routes inside the router use relative paths like '/', '/:id' because the router is mounted on the resource path (e.g., '/products').

2. Step 2: Identify the correct route paths

   const router = express.Router(); router.get('/', ...); router.post('/', ...); router.get('/:id', ...); router.put('/:id', ...); router.delete('/:id', ...); uses relative paths inside the router, which is the correct pattern. The router would be mounted with app.use('/products', router).

3. Step 3: Compare with other options

   const router = express.Router(); router.get('/products', ...); router.post('/products', ...); router.get('/products/:id', ...); router.put('/products/:id', ...); router.delete('/products/:id', ...); repeats the resource name in every route, which is redundant inside a router. The remaining options use non-standard paths that don't follow REST conventions.

4. Final Answer:

   const router = express.Router(); router.get('/', ...); router.post('/', ...); router.get('/:id', ...); router.put('/:id', ...); router.delete('/:id', ...); -> Option D

5. Quick Check:

   Use relative paths in router, mount on resource path [OK]

Hint: Inside router, use relative paths; mount router on resource path [OK]

Common Mistakes:

• Repeating resource name in every route inside router
• Using non-RESTful or verbose route paths
• Not mounting router on resource path