Namespaces for separation in Express

Introduction

Namespaces help organize routes in Express by grouping related paths together. This keeps your code clean and easy to manage.

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

You have multiple API versions and want to keep their routes distinct.

You want to group routes by feature, like products, orders, and customers.

You want to avoid route name conflicts by using prefixes.

You want to make your app easier to read and maintain.

Syntax

Express

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

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

// Use router with a namespace
app.use('/namespace', router);

The express.Router() creates a mini app for routes.

The app.use('/namespace', router) adds a prefix to all routes in the router.

Examples

This creates a /user/profile route by adding the /user namespace.

Express

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

This creates a /admin/dashboard route separate from other routes.

Express

const adminRouter = express.Router();
adminRouter.get('/dashboard', (req, res) => {
  res.send('Admin Dashboard');
});
app.use('/admin', adminRouter);

Sample Program

This Express app uses two namespaces: /user and /admin. Each has its own router with routes inside. This keeps user and admin routes separate and organized.

Express

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

const userRouter = express.Router();
userRouter.get('/profile', (req, res) => {
  res.send('User Profile Page');
});

const adminRouter = express.Router();
adminRouter.get('/dashboard', (req, res) => {
  res.send('Admin Dashboard Page');
});

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

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

Important Notes

Namespaces help avoid route conflicts by adding a clear prefix.

You can nest routers inside other routers for deeper organization.

Remember to use app.use() to connect routers with namespaces.

Summary

Namespaces group related routes under a common path prefix.

Use express.Router() to create route groups.

Attach routers to the main app with app.use('/namespace', router).

Practice

1. What is the main purpose of using namespaces in Express routing?

easy

A. To group related routes under a common path prefix

B. To improve database query speed

C. To style HTML elements

D. To manage user sessions

Solution

1. Step 1: Understand what namespaces do in Express

   Namespaces help organize routes by grouping them under a shared path prefix.

2. Step 2: Compare with other options

   Options B, C, and D relate to other concerns like database, styling, or sessions, not routing namespaces.

3. Final Answer:

   To group related routes under a common path prefix -> Option A

4. Quick Check:

   Namespaces = Group routes [OK]

Hint: Namespaces group routes by path prefix [OK]

Common Mistakes:

• Confusing namespaces with database or styling concepts
• Thinking namespaces manage sessions
• Believing namespaces affect frontend styling

2. Which of the following is the correct way to attach a router to an Express app under the namespace '/api'?

easy

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

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

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

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

Solution

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

   Express uses app.use(path, router) to mount routers under a path.

2. Step 2: Check other options for validity

   Options A, B, and C are not valid Express methods for attaching routers.

3. Final Answer:

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

4. Quick Check:

   Attach router with app.use() [OK]

Hint: Use app.use('/path', router) to attach routers [OK]

Common Mistakes:

• Using app.router instead of app.use
• Confusing app.route with router attachment
• Trying to use non-existent methods like app.attach

3. Given the code below, what will be the full URL path to access the route handler?

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

userRouter.get('/profile', (req, res) => res.send('User Profile'));
app.use('/user', userRouter);

medium

A. /user/profile

B. /profile

C. /user

D. /profile/user

Solution

1. Step 1: Identify the namespace prefix

   The router is attached with app.use('/user', userRouter), so '/user' is the base path.

2. Step 2: Combine router path with namespace

   The route inside the router is '/profile', so full path is '/user/profile'.

3. Final Answer:

   /user/profile -> Option A

4. Quick Check:

   Namespace + route = full path [OK]

Hint: Full path = namespace + router path [OK]

Common Mistakes:

• Ignoring the namespace prefix
• Using only the router path without prefix
• Mixing order of path segments

4. Identify the error in the following Express code that tries to create a namespace:

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

adminRouter.get('/dashboard', (req, res) => res.send('Admin Dashboard'));
app.use(adminRouter, '/admin');

medium

A. Missing app.listen call

B. adminRouter.get should be adminRouter.post

C. Router should be attached with app.use('/admin', adminRouter);

D. Cannot use express.Router() for namespaces

Solution

1. Step 1: Check app.use syntax

   The correct syntax is app.use('/path', router), but here arguments are reversed.

2. Step 2: Confirm other options

   adminRouter.get should be adminRouter.post is incorrect because GET is valid; C is unrelated to namespace error; D is false because express.Router() is used for namespaces.

3. Final Answer:

   Router should be attached with app.use('/admin', adminRouter); -> Option C

4. Quick Check:

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

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

Common Mistakes:

• Swapping arguments in app.use
• Thinking HTTP method must be POST
• Confusing missing listen with routing error

5. You want to create two separate namespaces in Express: '/api' for API routes and '/admin' for admin routes. Which code snippet correctly sets this up?

hard

A. const apiRouter = express.Router();
const adminRouter = express.Router();
app.route('/api', apiRouter);
app.route('/admin', adminRouter);

B. const apiRouter = express.Router();
const adminRouter = express.Router();
app.use('/api', apiRouter);
app.use('/admin', adminRouter);

C. const apiRouter = express.Router();
const adminRouter = express.Router();
app.use(apiRouter, '/api');
app.use(adminRouter, '/admin');

D. const apiRouter = express.Router();
const adminRouter = express.Router();
app.attach('/api', apiRouter);
app.attach('/admin', adminRouter);

Solution

1. Step 1: Create routers for each namespace

   Both apiRouter and adminRouter are created using express.Router().

2. Step 2: Attach routers with correct syntax

   Use app.use('/path', router) to mount routers under '/api' and '/admin'.

3. Step 3: Verify other options

   Options A, B, and D use incorrect methods or argument orders.

4. Final Answer:

   const apiRouter = express.Router(); const adminRouter = express.Router(); app.use('/api', apiRouter); app.use('/admin', adminRouter); -> Option B

5. Quick Check:

   Separate namespaces need separate routers and app.use() [OK]

Hint: Use separate routers and app.use('/path', router) [OK]

Common Mistakes:

• Reversing arguments in app.use
• Using app.route or app.attach incorrectly
• Trying to attach routers without namespaces