Virtual path prefixes in Express - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a virtual path prefix in Express?

A virtual path prefix is a path segment added before the actual route path when mounting middleware or routers. It helps organize routes under a common base URL without repeating the prefix in each route.

beginner

How do you use a virtual path prefix with an Express router?

You use app.use('/prefix', router) to mount the router so all routes inside the router are accessed under '/prefix'. For example, if router has '/users', the full path becomes '/prefix/users'.

beginner

Why use virtual path prefixes instead of writing full paths in each route?

Virtual path prefixes keep code cleaner and easier to maintain by grouping related routes under one base path. It avoids repeating the same prefix in every route definition.

beginner

Example: What URL path will respond if you mount a router with app.use('/api', router) and router has router.get('/items')?

The URL path '/api/items' will respond because '/api' is the virtual prefix and '/items' is the route inside the router.

intermediate

Can virtual path prefixes be nested in Express?

Yes, you can nest routers with their own prefixes. For example, app.use('/api', apiRouter) and inside apiRouter you use apiRouter.use('/v1', v1Router). The full path becomes '/api/v1/...'.

What does app.use('/admin', adminRouter) do in Express?

A Mounts adminRouter so all its routes start with '/admin'

B Changes all routes to '/admin' only

C Removes '/admin' from all routes

D Creates a new server on '/admin'

app.use('/admin', adminRouter) mounts the router so all routes inside adminRouter are prefixed with '/admin'.

If router has router.get('/profile'), and you mount it with app.use('/user', router), what URL path responds?

A /profile

B /profile/user

C /user

D /user/profile

The virtual prefix '/user' is added before '/profile', so the full path is '/user/profile'.

Why are virtual path prefixes useful?

A They speed up server response

B They organize routes under a common base path

C They encrypt URLs

D They disable routes

Virtual path prefixes help organize routes by grouping them under a shared base URL.

Can you mount multiple routers with different virtual prefixes in Express?

A No, only one router per app

B Only if routers have no routes

C Yes, each with its own prefix

D Only if prefixes are the same

You can mount many routers each with different virtual path prefixes to organize routes.

What happens if you mount a router without a virtual path prefix like app.use(router)?

A Routes are mounted at root '/'

B Routes are disabled

C Routes get random prefixes

D Server crashes

Mounting without a prefix means routes are accessible directly at their defined paths from the root.

Explain what a virtual path prefix is in Express and why it is helpful.

Think about grouping routes under one common URL segment.

Describe how you would use virtual path prefixes to organize routes for an API with versions like /api/v1 and /api/v2.

Consider nesting routers with app.use calls.

Practice

1. What is the main purpose of using a virtual path prefix in Express with app.use('/prefix', router)?

easy

A. To handle errors globally in the app

B. To create a new Express app instance

C. To serve static files from a directory

D. To group routes under a common URL path for better organization

Solution

1. Step 1: Understand what app.use('/prefix', router) does

   This syntax mounts a router or middleware under the URL path '/prefix'.

2. Step 2: Identify the purpose of grouping routes

   Grouping routes under a common prefix helps organize and maintain the app's URL structure.

3. Final Answer:

   To group routes under a common URL path for better organization -> Option D

4. Quick Check:

   Virtual path prefix = route grouping [OK]

Hint: Virtual path prefixes group routes under one URL path [OK]

Common Mistakes:

• Thinking it creates a new app instance
• Confusing with static file serving
• Assuming it handles errors

2. Which of the following is the correct syntax to mount a router on the virtual path prefix '/api' in Express?

easy

A. app.route('/api', router);

B. app.use('/api', router);

C. app.mount('/api', router);

D. app.router('/api', router);

Solution

1. Step 1: Recall Express method to mount middleware or routers

   Express uses app.use(path, middleware) to mount routers or middleware.

2. Step 2: Check each option's method name

   Only app.use is the correct method; others like app.route, app.mount, and app.router are invalid or incorrect here.

3. Final Answer:

   app.use('/api', router); -> Option B

4. Quick Check:

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

Hint: Use app.use to mount routers on paths [OK]

Common Mistakes:

• Using app.route instead of app.use
• Trying non-existent methods like app.mount
• Confusing router mounting with route definitions

3. Given the code below, what URL path will respond with 'Hello from admin'?

const express = require('express');
const app = express();
const adminRouter = express.Router();
adminRouter.get('/', (req, res) => res.send('Hello from admin'));
app.use('/admin', adminRouter);
app.listen(3000);

medium

A. http://localhost:3000/

B. http://localhost:3000/admin

C. http://localhost:3000/admin/

D. http://localhost:3000/admin/home

Solution

1. Step 1: Understand the router path and mounting prefix

   The router handles GET requests at '/' and is mounted at '/admin'.

2. Step 2: Combine prefix and router path

   The full path is '/admin' + '/' = '/admin/'.

3. Step 3: Understand URL normalization

   URLs with or without trailing slash for this route behave the same in Express, so both '/admin' and '/admin/' respond with 'Hello from admin'.

4. Final Answer:

   http://localhost:3000/admin/ and http://localhost:3000/admin -> Option C

5. Quick Check:

   Router '/' + mount '/admin' = '/admin/' and '/admin' [OK]

Hint: Combine mount path and router path for full URL; trailing slash optional [OK]

Common Mistakes:

• Ignoring trailing slash in URL
• Assuming root '/' responds without prefix
• Confusing '/admin' and '/admin/home'

4. Identify the error in this Express code snippet that tries to mount a router with a virtual path prefix:

const express = require('express');
const app = express();
const userRouter = express.Router();
userRouter.get('/profile', (req, res) => res.send('User Profile'));
app.use(userRouter, '/user');
app.listen(3000);

medium

A. The order of arguments in app.use is incorrect

B. The router path '/profile' is invalid

C. Missing app.listen call

D. Router should be created with express() not express.Router()

Solution

1. Step 1: Check the app.use argument order

   Correct syntax is app.use(path, router), but here it is reversed.

2. Step 2: Identify the correct argument order

   It should be app.use('/user', userRouter) to mount the router at '/user'.

3. Final Answer:

   The order of arguments in app.use is incorrect -> Option A

4. Quick Check:

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

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

Common Mistakes:

• Swapping router and path arguments
• Thinking router path is invalid
• Forgetting to call app.listen

5. You want to create an Express app with two routers: adminRouter mounted at '/admin' and userRouter mounted at '/user'. Both routers have a route for '/' that sends different greetings. Which code correctly sets this up so visiting '/admin' and '/user' shows the correct messages?

hard

A. app.use('/admin', adminRouter);
app.use('/user', userRouter);

B. app.use(adminRouter, '/admin');
app.use(userRouter, '/user');

C. app.route('/admin', adminRouter);
app.route('/user', userRouter);

D. app.get('/admin', adminRouter);
app.get('/user', userRouter);

Solution

1. Step 1: Recall correct syntax for mounting routers with prefixes

   Use app.use(path, router) to mount routers at virtual path prefixes.

2. Step 2: Evaluate the options

   The correct code uses app.use('/admin', adminRouter); and app.use('/user', userRouter);. Distractors use invalid methods like app.route() or app.get() with routers, or reverse the path and router order in app.use().

3. Final Answer:

   app.use('/admin', adminRouter); app.use('/user', userRouter); -> Option A

4. Quick Check:

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

Hint: Mount routers with app.use(path, router) for multiple prefixes [OK]

Common Mistakes:

• Swapping router and path in app.use
• Using app.route or app.get to mount routers
• Not mounting routers at all