Mounting routers with app.use in Express

Introduction

Mounting routers with app.use helps organize your web app by grouping related routes together. It keeps your code clean and easier to manage.

You want to separate user-related routes from product-related routes in your app.

You have many routes and want to split them into smaller files for better organization.

You want to reuse a set of routes in different parts of your app.

You want to add middleware to a group of routes easily.

You want to keep your main app file simple and clean.

Syntax

Express

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

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

// Mount the router on a path
app.use('/basepath', router);

app.use mounts the router at the specified base path.

Routes inside the router will be relative to the base path.

Examples

This mounts userRouter at /users. Visiting /users shows 'User home'.

Express

const express = require('express');
const app = express();
const userRouter = express.Router();

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

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

This mounts productRouter at /products. Visiting /products/list shows 'Product list'.

Express

const express = require('express');
const app = express();
const productRouter = express.Router();

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

app.use('/products', productRouter);

Sample Program

This example creates a blogRouter with two routes: '/' and '/post'. It mounts the router at '/blog'. So, visiting '/blog' shows 'Welcome to the blog home' and '/blog/post' shows 'This is a blog post'.

Express

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

// Create a router for blog routes
const blogRouter = express.Router();

// Define a route on blogRouter
blogRouter.get('/', (req, res) => {
  res.send('Welcome to the blog home');
});

blogRouter.get('/post', (req, res) => {
  res.send('This is a blog post');
});

// Mount blogRouter at /blog
app.use('/blog', blogRouter);

// Start the server
app.listen(port, () => {
  console.log(`Server running on http://localhost:${port}`);
});

Important Notes

Remember that the paths inside the router are relative to the mount path.

You can mount multiple routers on different paths to keep your app organized.

Use app.use to add middleware or routers to your app.

Summary

Mounting routers with app.use helps organize routes by grouping them under a base path.

It makes your code cleaner and easier to maintain.

Routes inside routers are relative to the path you mount them on.

Practice

1. What is the main purpose of using app.use to mount routers in Express?

easy

A. To automatically generate HTML pages

B. To directly send responses without defining routes

C. To group related routes under a common base path for better organization

D. To replace the Express app with a router

Solution

1. Step 1: Understand what app.use does

   app.use mounts middleware or routers at a specified path, grouping routes.

2. Step 2: Identify the benefit of mounting routers

   Mounting routers organizes routes under a base path, making code cleaner and easier to maintain.

3. Final Answer:

   To group related routes under a common base path for better organization -> Option C

4. Quick Check:

   Mount routers = group routes [OK]

Hint: Mount routers to group routes under one path [OK]

Common Mistakes:

• Thinking app.use replaces the app
• Believing it sends responses directly
• Confusing mounting with automatic page generation

2. Which of the following is the correct syntax to mount a router named userRouter on the path /users using app.use?

easy

A. app.use('/users', userRouter);

B. app.use(userRouter, '/users');

C. app.get('/users', userRouter);

D. app.mount('/users', userRouter);

Solution

1. Step 1: Recall the app.use syntax

   The correct syntax is app.use(path, router) to mount a router at a path.

2. Step 2: Match the correct order and method

   app.use('/users', userRouter); uses app.use('/users', userRouter); which is correct. Others have wrong order or method.

3. Final Answer:

   app.use('/users', userRouter); -> Option A

4. Quick Check:

   app.use(path, router) = correct syntax [OK]

Hint: Remember: app.use(path, router) mounts router [OK]

Common Mistakes:

• Swapping router and path order
• Using app.get instead of app.use
• Using non-existent app.mount method

3. Given the following code, what URL path will respond with 'User list'?

const express = require('express');
const app = express();
const userRouter = express.Router();

userRouter.get('/', (req, res) => res.send('User list'));

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

medium

A. /users/

B. /

C. /user/

D. /users/list

Solution

1. Step 1: Understand router path and mounting

   The router defines a GET route at '/' which is relative to where it is mounted.

2. Step 2: Combine mount path and router route

   Since userRouter is mounted at '/users', the full path is '/users/' to reach the route.

3. Final Answer:

   /users/ -> Option A

4. Quick Check:

   Mount path + router route = full URL [OK]

Hint: Router path '/' + mount '/users' = '/users/' [OK]

Common Mistakes:

• Ignoring mount path and using '/' alone
• Confusing '/user/' with '/users/'
• Assuming '/users/list' without route defined

4. What is wrong with this code snippet?

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

router.get('/info', (req, res) => res.send('Info page'));

app.use(router, '/info');

medium

A. Missing app.listen call

B. Router cannot have routes with '/info' path

C. app.use cannot mount routers

D. The arguments to app.use are in the wrong order

Solution

1. Step 1: Check app.use argument order

   The correct order is app.use(path, router), but here it is reversed.

2. Step 2: Identify the error cause

   Passing router first and path second causes Express to treat router as middleware without a path, leading to unexpected behavior.

3. Final Answer:

   The arguments to app.use are in the wrong order -> Option D

4. Quick Check:

   app.use(path, router) order matters [OK]

Hint: app.use(path, router) order is strict [OK]

Common Mistakes:

• Swapping router and path in app.use
• Thinking router paths can't have '/info'
• Ignoring missing app.listen (not related here)

5. You want to mount two routers, adminRouter and userRouter, so that /admin/dashboard and /users/profile work correctly. Which code correctly mounts both routers?

hard

A. app.use(adminRouter, '/admin');\napp.use(userRouter, '/users');

B. app.use('/admin', adminRouter);\napp.use('/users', userRouter);

C. app.use('/admin/dashboard', adminRouter);\napp.use('/users/profile', userRouter);

D. app.get('/admin', adminRouter);\napp.get('/users', userRouter);

Solution

1. Step 1: Understand mounting routers at base paths

   Mount routers at base paths like '/admin' and '/users' so their internal routes append correctly.

2. Step 2: Check each option for correct syntax and paths

   app.use('/admin', adminRouter);\napp.use('/users', userRouter); uses app.use('/admin', adminRouter); and app.use('/users', userRouter);, which is correct. app.use(adminRouter, '/admin');\napp.use(userRouter, '/users'); swaps arguments, C mounts at full paths (not base), D uses app.get which is incorrect for mounting routers.

3. Final Answer:

   app.use('/admin', adminRouter); app.use('/users', userRouter); -> Option B

4. Quick Check:

   Mount routers at base paths with app.use(path, router) [OK]

Hint: Mount routers at base paths with app.use(path, router) [OK]

Common Mistakes:

• Swapping router and path in app.use
• Mounting routers at full nested paths
• Using app.get instead of app.use for routers