Route matching order matters in Express

Introduction

Route matching order matters because Express checks routes in the order you write them. The first route that matches the request is used, so order controls which code runs.

When you have multiple routes that could match similar URLs.

When you want a specific route to handle requests before a more general route.

When you use wildcard or parameter routes that can catch many URLs.

When you want to avoid unexpected route handling by placing specific routes first.

When debugging why a route is not being reached because another route matched first.

Syntax

Express

app.METHOD(PATH, HANDLER)

// Example:
app.get('/users/all', handlerFunction)
app.get('/users/:id', handlerFunction)

Routes are checked top to bottom in the order they appear in your code.

More specific routes should come before more general or wildcard routes.

Examples

Specific route '/users/all' is placed before the parameter route '/users/:id' to avoid matching 'all' as an id.

Express

app.get('/users/all', (req, res) => {
  res.send('All users')
})

app.get('/users/:id', (req, res) => {
  res.send(`User ${req.params.id}`)
})

Wildcard route placed before specific route causes the specific route never to run.

Express

app.get('/files/*', (req, res) => {
  res.send('Wildcard route')
})

app.get('/files/special', (req, res) => {
  res.send('Special file')
})

Correct order: specific route first, wildcard last.

Express

app.get('/files/special', (req, res) => {
  res.send('Special file')
})

app.get('/files/*', (req, res) => {
  res.send('Wildcard route')
})

Sample Program

This example shows the specific route before the parameter route. Requests to '/item/special' will match the specific route first and not the parameter route.

Placing the specific route first ensures correct matching.

Express

import express from 'express'
const app = express()

app.get('/item/special', (req, res) => {
  res.send('Special Item')
})

app.get('/item/:id', (req, res) => {
  res.send(`Item ID: ${req.params.id}`)
})

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

Important Notes

Always put specific routes before parameter or wildcard routes to ensure correct matching.

Order affects which route handles the request, so plan route order carefully.

Use console logs or debugging to check which route runs if unsure.

Summary

Express matches routes in the order they are defined.

Specific routes should come before general or wildcard routes.

Route order controls which handler runs for a request.

Practice

1. In Express, why does the order of route definitions matter?
app.get('/user', ...) and app.get('/:id', ...) are defined. Which route will handle /user if /:id is defined first?

easy

A. The most specific route always handles the request regardless of order.

B. Express matches all routes and runs all handlers regardless of order.

C. The first matching route in order handles the request, so /:id will handle /user.

D. Express throws an error if routes overlap.

Solution

1. Step 1: Understand Express route matching order

   Express checks routes in the order they are defined and stops at the first match.

2. Step 2: Analyze the given routes

   If /:id is defined before /user, the path /user matches /:id first, so that handler runs.

3. Final Answer:

   The first matching route in order handles the request, so /:id will handle /user. -> Option C

4. Quick Check:

   Route order controls matching = C [OK]

Hint: Remember: Express uses first match wins rule [OK]

Common Mistakes:

• Thinking Express runs all matching routes
• Assuming specific routes override order automatically
• Believing Express throws errors on overlapping routes

2. Which of the following is the correct way to define routes so that /about is handled before any dynamic /:page route in Express?

easy

A. app.get('/:page', handler); app.get('/about', handler);

B. app.get('/about', handler); app.get('/:page', handler);

C. app.get('/about', handler); app.use('/:page', handler);

D. app.use('/:page', handler); app.get('/about', handler);

Solution

1. Step 1: Recall route order importance

   Specific routes like /about must be defined before dynamic routes like /:page to match first.

2. Step 2: Check options for correct order

   app.get('/about', handler); app.get('/:page', handler); defines /about first, then /:page, ensuring /about matches before dynamic routes.

3. Final Answer:

   app.get('/about', handler); app.get('/:page', handler); -> Option B

4. Quick Check:

   Specific before dynamic = A [OK]

Hint: Put specific routes before dynamic ones [OK]

Common Mistakes:

• Defining dynamic routes before specific ones
• Using app.use instead of app.get for specific routes
• Assuming order doesn't affect matching

3. Given the following Express routes:

app.get('/product/:id', (req, res) => res.send('Product ' + req.params.id));
app.get('/product/list', (req, res) => res.send('Product List'));

What will be the response when a client requests /product/list?

medium

A. 'Product List'

B. 'Product list'

C. 404 Not Found

D. Error: Route conflict

Solution

1. Step 1: Check route order

   The dynamic route /product/:id is defined before the specific /product/list route.

2. Step 2: Determine which route matches first

   Request /product/list matches /product/:id first, so it returns 'Product list'.

3. Step 3: Check case sensitivity

   The specific route sends 'Product List' with capital 'L', while the dynamic route sends 'Product ' + id, which would be 'Product list' if matched.

4. Final Answer:

   'Product List' -> Option A

5. Quick Check:

   Specific route matches only if defined before dynamic [OK]

Hint: First matching route runs, order matters for specific vs dynamic [OK]

Common Mistakes:

• Assuming specific route matches first regardless of order
• Expecting 404 when dynamic route matches
• Thinking Express throws route conflict errors

4. You have these Express routes:

app.get('/:category', handler1);
app.get('/books', handler2);

Requests to /books always go to handler1. How do you fix this?

medium

A. Move app.get('/books', handler2) before app.get('/:category', handler1).

B. Change /:category to /category/:name.

C. Use app.use instead of app.get for /books.

D. Rename /books to /books/all.

Solution

1. Step 1: Identify route order problem

   The dynamic route /:category matches /books first because it is defined before the specific route.

2. Step 2: Fix by reordering routes

   Moving the specific /books route before the dynamic one ensures /books matches handler2 first.

3. Final Answer:

   Move app.get('/books', handler2) before app.get('/:category', handler1). -> Option A

4. Quick Check:

   Specific routes before dynamic fix matching [OK]

Hint: Place specific routes above dynamic routes [OK]

Common Mistakes:

• Changing route paths unnecessarily
• Using app.use instead of app.get incorrectly
• Ignoring route order importance

5. You want to create an Express app where:
- /api/users returns a user list
- /api/:resource returns data for any resource

How should you order these routes to ensure /api/users returns the user list and /api/products returns product data?

hard

A. Define /api/:resource first, then /api/users.

B. Combine both routes into one with conditional logic inside.

C. Use app.use for /api/users and app.get for /api/:resource.

D. Define /api/users first, then /api/:resource.

Solution

1. Step 1: Understand route specificity and order

   Specific routes like /api/users must be defined before dynamic routes like /api/:resource to match correctly.

2. Step 2: Apply correct order

   Defining /api/users first ensures requests to /api/users hit that route, while other resources match the dynamic route.

3. Final Answer:

   Define /api/users first, then /api/:resource. -> Option D

4. Quick Check:

   Specific before dynamic for correct matching [OK]

Hint: Always put specific API routes before dynamic ones [OK]

Common Mistakes:

• Defining dynamic route before specific API routes
• Using app.use incorrectly for route handlers
• Trying to merge routes instead of ordering