Separating routes into files in Express

Introduction

Separating routes into files helps keep your code organized and easier to manage. It makes your app cleaner and simpler to understand.

When your app has many routes and the main file becomes too long.

When you want to group related routes together, like user routes in one file and product routes in another.

When working in a team, so different people can work on different route files without conflicts.

When you want to reuse routes in different parts of your app or in other apps.

Syntax

Express

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

// Define routes
router.get('/path', (req, res) => {
  res.send('response');
});

module.exports = router;

Use express.Router() to create a new router object.

Export the router to use it in your main app file.

Examples

This example creates a route that sends a greeting message.

Express

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

router.get('/hello', (req, res) => {
  res.send('Hello from routes file!');
});

module.exports = router;

This example shows a POST route for form submission.

Express

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

router.post('/submit', (req, res) => {
  res.send('Form submitted');
});

module.exports = router;

Sample Program

This example shows how to separate user-related routes into a users.js file inside a routes folder. The main app file imports and uses these routes under the /users path.

Express

// routes/users.js
const express = require('express');
const router = express.Router();

router.get('/', (req, res) => {
  res.send('User list');
});

router.get('/:id', (req, res) => {
  res.send(`User details for ID: ${req.params.id}`);
});

module.exports = router;

// app.js
const express = require('express');
const app = express();
const userRoutes = require('./routes/users');

app.use('/users', userRoutes);

app.listen(3000, () => {
  console.log('Server running on http://localhost:3000');
});

Important Notes

Always use app.use() to connect your route files to the main app.

Keep route files focused on related routes to stay organized.

Remember to export your router with module.exports.

Summary

Separating routes into files keeps your app clean and organized.

Use express.Router() to create route modules.

Import and use route files in your main app with app.use().

Practice

1. What is the main benefit of separating routes into different files in an Express app?

easy

A. It makes the app run faster.

B. It keeps the app organized and easier to maintain.

C. It automatically secures the routes.

D. It removes the need for middleware.

Solution

1. Step 1: Understand code organization

   Separating routes into files helps keep code clean and manageable as the app grows.

2. Step 2: Identify benefits

   This separation does not affect speed or security directly but improves maintainability.

3. Final Answer:

   It keeps the app organized and easier to maintain. -> Option B

4. Quick Check:

   Organized code = easier maintenance [OK]

Hint: Think about code clarity and maintenance benefits [OK]

Common Mistakes:

• Confusing organization with performance improvements
• Assuming route separation adds security automatically
• Thinking middleware is not needed after separation

2. Which of the following is the correct way to create a router in a separate file named users.js?

easy

A. const router = express.Router(); module.exports = router;

B. const router = new express.Router(); export default router;

C. const router = express.Router; module.exports = router();

D. const router = express.Router(); export router;

Solution

1. Step 1: Create router instance correctly

   Use express.Router() to create a new router instance.

2. Step 2: Export the router properly

   Use module.exports = router; to export it for use in other files.

3. Final Answer:

   const router = express.Router(); module.exports = router; -> Option A

4. Quick Check:

   Correct router creation and export = const router = express.Router(); module.exports = router; [OK]

Hint: Remember to call Router() and use module.exports [OK]

Common Mistakes:

• Forgetting parentheses after Router
• Mixing CommonJS and ES module syntax
• Exporting router incorrectly

3. Given the following code in users.js:

const express = require('express');
const router = express.Router();
router.get('/profile', (req, res) => {
  res.send('User Profile');
});
module.exports = router;

And in app.js:

const express = require('express');
const app = express();
const usersRouter = require('./users');
app.use('/users', usersRouter);
app.listen(3000);

What will be the response when a client requests /users/profile?

medium

A. User Profile

B. Cannot GET /users/profile

C. 404 Not Found error

D. Server crashes with error

Solution

1. Step 1: Understand route prefixing

   The router is mounted at /users, so /profile inside router becomes /users/profile.

2. Step 2: Check route handler response

   The route /profile sends 'User Profile' as response.

3. Final Answer:

   User Profile -> Option A

4. Quick Check:

   Route prefix + handler response = 'User Profile' [OK]

Hint: Remember mounted path prefixes router routes [OK]

Common Mistakes:

• Forgetting the prefix from app.use
• Expecting route at root instead of prefixed path
• Assuming 404 without checking router setup

4. You have this code in products.js:

const express = require('express');
const router = express.Router();
router.get('/list', (req, res) => {
  res.send('Product List');
});
// Missing module.exports here

And in app.js:

const express = require('express');
const app = express();
const productsRouter = require('./products');
app.use('/products', productsRouter);
app.listen(3000);

What error will occur when starting the app or accessing /products/list?

medium

A. SyntaxError due to missing export

B. TypeError: Cannot read property 'use' of undefined

C. No error, but route won't respond

D. productsRouter is undefined, causing an error

Solution

1. Step 1: Check module export in products.js

   Since module.exports is missing, require('./products') returns undefined.

2. Step 2: Understand impact in app.js

   Using undefined as router in app.use causes an error when app tries to use it.

3. Final Answer:

   productsRouter is undefined, causing an error -> Option D

4. Quick Check:

   Missing export = undefined import error [OK]

Hint: Always export router to avoid undefined imports [OK]

Common Mistakes:

• Assuming app runs without export
• Confusing syntax error with runtime error
• Not checking module.exports presence

5. You want to separate routes for /api/users and /api/products into two files: users.js and products.js. Each file exports a router with routes starting at /. How should you mount these routers in app.js to correctly handle requests to /api/users/profile and /api/products/list?

hard

A. app.use('/api', usersRouter); app.use('/api', productsRouter);

B. app.use('/users', usersRouter); app.use('/products', productsRouter);

C. app.use('/api/users', usersRouter); app.use('/api/products', productsRouter);

D. app.use('/', usersRouter); app.use('/', productsRouter);

Solution

1. Step 1: Understand router base paths

   Each router handles routes starting at /, so mounting them at specific paths adds prefixes.

2. Step 2: Mount routers with full API paths

   Mount usersRouter at /api/users and productsRouter at /api/products to match desired URLs.

3. Final Answer:

   app.use('/api/users', usersRouter); app.use('/api/products', productsRouter); -> Option C

4. Quick Check:

   Mount routers at full paths for correct URL handling [OK]

Hint: Mount routers at full URL prefixes to match routes [OK]

Common Mistakes:

• Mounting routers at wrong or incomplete paths
• Mounting both routers at same path causing conflicts
• Assuming routers handle full paths internally