Why is express matching two routes?

All we need is an easy explanation of the problem, so here it is.

I have an express API with a bunch of routes.

routes.get('/',                      perms('read', 'document'),   r(CRUD.getAll))
routes.get('/search',                perms('read', 'document'),   r(CRUD.search))
routes.get('/:id',                   perms('read', 'document'),   r(CRUD.getById))

I made sure to have /search above /:id, however, when a new request comes in to /search, I see both endpoints getting a hit (I added a console.log inside of each function).

I tried flipping the two and in that case, only /:id gets a hit.

Any idea of why this may be happening?

Why is express matching two routes?

How to solve :

I know you bored from this bug, So we are here to help you! Take a deep breath and look at the explanation of your problem. We have many solutions to this problem, But we recommend you to use the first method because it is tested & true method that will 100% work for you.

Method 1

Think about Express routing as an array of handlers (middlewares), that have a matching rule (url). When a request comes in, the router starts checking each item in the array from the beginning. If it matches the rule, then the handler is run (some don’t have conditions, so they just run on each request :)). The request chain does not end when a single url is matched! You can execute multiple handlers on the same request (and that’s exactly how middlewares work).

Therefore, it really depends on what happens inside your handler. You can tell it to continue with the next item in the list, and if there’s a match – the next handler will be executed (like /search and /:id, which will be search again).

Make sure you end your response. Beware if you call next and with what parameters. Post some samples of the handlers in order to debug it more 🙂

Note: Use and implement method 1 because this method fully tested our system.
Thank you 🙂

All methods was sourced from stackoverflow.com or stackexchange.com, is licensed under cc by-sa 2.5, cc by-sa 3.0 and cc by-sa 4.0

Leave a Reply