Skip to content

docs: clarify route path matching #2444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vibhor-aggr wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify route path matching #2444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 33 additions & 22 deletions src/content/api/4x/api/application/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,9 +264,10 @@ app.use('/admin', admin);
<Signature>
<Fragment slot="attributes">
<Param name="path" type="String | RegExp | Array">
The path for which the middleware function is invoked; can be any of: a string representing a
path, a path pattern, a regular expression pattern to match paths, or an array of combinations
of any of the above. For examples, see [Path examples](#path-examples).
The path for which the route callback is invoked; can be any of: a string representing a path,
a path pattern, a regular expression pattern to match paths, or an array of combinations of
any of the above. Route paths match complete request paths; for syntax examples, see [Path
examples](#path-examples).
</Param>
<Param name="callback" type="Function | Function[]">
Callback functions; can be: a middleware function, a series of middleware functions (separated
Expand Down Expand Up @@ -337,9 +338,10 @@ app.all('/api/*', requireAuthentication);
<Signature>
<Fragment slot="attributes">
<Param name="path" type="String | RegExp | Array">
The path for which the middleware function is invoked; can be any of: a string representing a
path, a path pattern, a regular expression pattern to match paths, or an array of combinations
of any of the above. For examples, see [Path examples](#path-examples).
The path for which the route callback is invoked; can be any of: a string representing a path,
a path pattern, a regular expression pattern to match paths, or an array of combinations of
any of the above. Route paths match complete request paths; for syntax examples, see [Path
examples](#path-examples).
</Param>
<Param name="callback" type="Function | Function[]">
Callback functions; can be: a middleware function, a series of middleware functions (separated
Expand Down Expand Up @@ -568,9 +570,10 @@ app.get('title');
<Signature>
<Fragment slot="attributes">
<Param name="path" type="String | RegExp | Array">
The path for which the middleware function is invoked; can be any of: a string representing a
path, a path pattern, a regular expression pattern to match paths, or an array of combinations
of any of the above. For examples, see [Path examples](#path-examples).
The path for which the route callback is invoked; can be any of: a string representing a path,
a path pattern, a regular expression pattern to match paths, or an array of combinations of
any of the above. Route paths match complete request paths; for syntax examples, see [Path
examples](#path-examples).
</Param>
<Param name="callback" type="Function | Function[]">
Callback functions; can be: a middleware function, a series of middleware functions (separated
Expand Down Expand Up @@ -719,9 +722,10 @@ All the forms of Node's [http.Server.listen()](https://nodejs.org/api/http.html#
<Signature>
<Fragment slot="attributes">
<Param name="path" type="String | RegExp | Array">
The path for which the middleware function is invoked; can be any of: a string representing a
path, a path pattern, a regular expression pattern to match paths, or an array of combinations
of any of the above. For examples, see [Path examples](#path-examples).
The path for which the route callback is invoked; can be any of: a string representing a path,
a path pattern, a regular expression pattern to match paths, or an array of combinations of
any of the above. Route paths match complete request paths; for syntax examples, see [Path
examples](#path-examples).
</Param>
<Param name="callback" type="Function | Function[]">
Callback functions; can be: a middleware function, a series of middleware functions (separated
Expand All @@ -741,6 +745,10 @@ Routes an HTTP request, where METHOD is the HTTP method of the request, such as
PUT, POST, and so on, in lowercase. Thus, the actual methods are `app.get()`,
`app.post()`, `app.put()`, and so on. See [Routing methods](#routing-methods) below for the complete list.

Route paths match the complete request path for a route. Unlike [app.use()](#appuse), a route path
does not match path prefixes by default. For example, `app.get('/apple', ...)` matches "/apple" but
not "/apple/images" unless the path pattern is written to match that longer path.

#### Routing methods

Express supports the following routing methods corresponding to the HTTP methods of the same names:
Expand Down Expand Up @@ -830,9 +838,10 @@ For more information on routing, see the [routing guide](/guide/routing/).
<Signature runtime={{ 'Node.js': '>=20.19.3 <21 || >=22.2.0' }}>
<Fragment slot="attributes">
<Param name="path" type="String | RegExp | Array">
The path for which the middleware function is invoked; can be any of: a string representing a
path, a path pattern, a regular expression pattern to match paths, or an array of combinations
of any of the above. For examples, see [Path examples](#path-examples).
The path for which the route callback is invoked; can be any of: a string representing a path,
a path pattern, a regular expression pattern to match paths, or an array of combinations of
any of the above. Route paths match complete request paths; for syntax examples, see [Path
examples](#path-examples).
</Param>
<Param name="callback" type="Function | Function[]">
Callback functions; can be: a middleware function, a series of middleware functions (separated
Expand Down Expand Up @@ -1203,9 +1212,10 @@ it is usually better to use [req.baseUrl](/api/request/#reqbaseurl) to get the c
<Signature>
<Fragment slot="attributes">
<Param name="path" type="String | RegExp | Array">
The path for which the middleware function is invoked; can be any of: a string representing a
path, a path pattern, a regular expression pattern to match paths, or an array of combinations
of any of the above. For examples, see [Path examples](#path-examples).
The path for which the route callback is invoked; can be any of: a string representing a path,
a path pattern, a regular expression pattern to match paths, or an array of combinations of
any of the above. Route paths match complete request paths; for syntax examples, see [Path
examples](#path-examples).
</Param>
<Param name="callback" type="Function | Function[]">
Callback functions; can be: a middleware function, a series of middleware functions (separated
Expand Down Expand Up @@ -1245,9 +1255,10 @@ app.post('/', function (req: Request, res: Response) {
<Signature>
<Fragment slot="attributes">
<Param name="path" type="String | RegExp | Array">
The path for which the middleware function is invoked; can be any of: a string representing a
path, a path pattern, a regular expression pattern to match paths, or an array of combinations
of any of the above. For examples, see [Path examples](#path-examples).
The path for which the route callback is invoked; can be any of: a string representing a path,
a path pattern, a regular expression pattern to match paths, or an array of combinations of
any of the above. Route paths match complete request paths; for syntax examples, see [Path
examples](#path-examples).
</Param>
<Param name="callback" type="Function | Function[]">
Callback functions; can be: a middleware function, a series of middleware functions (separated
Expand Down Expand Up @@ -1651,7 +1662,7 @@ the middleware function is executed when the base of the requested path matches

#### Description

A route will match any path that follows its path immediately with a "`/`".
Middleware mounted with `app.use()` will match any path that follows its path immediately with a "`/`".
For example: `app.use('/apple', ...)` will match "/apple", "/apple/images",
"/apple/images/news", and so on.

Expand Down
55 changes: 33 additions & 22 deletions src/content/api/5x/api/application/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,9 +312,10 @@ app.use('/admin', admin);
<Signature>
<Fragment slot="attributes">
<Param name="path" type="String | RegExp | Array">
The path for which the middleware function is invoked; can be any of: a string representing a
path, a path pattern, a regular expression pattern to match paths, or an array of combinations
of any of the above. For examples, see [Path examples](#path-examples).
The path for which the route callback is invoked; can be any of: a string representing a path,
a path pattern, a regular expression pattern to match paths, or an array of combinations of
any of the above. Route paths match complete request paths; for syntax examples, see [Path
examples](#path-examples).
</Param>
<Param name="callback" type="Function | Function[]">
Callback functions; can be: a middleware function, a series of middleware functions (separated
Expand Down Expand Up @@ -385,9 +386,10 @@ app.all('/api/{*splat}', requireAuthentication);
<Signature>
<Fragment slot="attributes">
<Param name="path" type="String | RegExp | Array">
The path for which the middleware function is invoked; can be any of: a string representing a
path, a path pattern, a regular expression pattern to match paths, or an array of combinations
of any of the above. For examples, see [Path examples](#path-examples).
The path for which the route callback is invoked; can be any of: a string representing a path,
a path pattern, a regular expression pattern to match paths, or an array of combinations of
any of the above. Route paths match complete request paths; for syntax examples, see [Path
examples](#path-examples).
</Param>
<Param name="callback" type="Function | Function[]">
Callback functions; can be: a middleware function, a series of middleware functions (separated
Expand Down Expand Up @@ -593,9 +595,10 @@ app.get('title');
<Signature>
<Fragment slot="attributes">
<Param name="path" type="String | RegExp | Array">
The path for which the middleware function is invoked; can be any of: a string representing a
path, a path pattern, a regular expression pattern to match paths, or an array of combinations
of any of the above. For examples, see [Path examples](#path-examples).
The path for which the route callback is invoked; can be any of: a string representing a path,
a path pattern, a regular expression pattern to match paths, or an array of combinations of
any of the above. Route paths match complete request paths; for syntax examples, see [Path
examples](#path-examples).
</Param>
<Param name="callback" type="Function | Function[]">
Callback functions; can be: a middleware function, a series of middleware functions (separated
Expand Down Expand Up @@ -763,9 +766,10 @@ actually supported.
<Signature>
<Fragment slot="attributes">
<Param name="path" type="String | RegExp | Array">
The path for which the middleware function is invoked; can be any of: a string representing a
path, a path pattern, a regular expression pattern to match paths, or an array of combinations
of any of the above. For examples, see [Path examples](#path-examples).
The path for which the route callback is invoked; can be any of: a string representing a path,
a path pattern, a regular expression pattern to match paths, or an array of combinations of
any of the above. Route paths match complete request paths; for syntax examples, see [Path
examples](#path-examples).
</Param>
<Param name="callback" type="Function | Function[]">
Callback functions; can be: a middleware function, a series of middleware functions (separated
Expand All @@ -785,6 +789,10 @@ Routes an HTTP request, where METHOD is the HTTP method of the request, such as
PUT, POST, and so on, in lowercase. Thus, the actual methods are `app.get()`,
`app.post()`, `app.put()`, and so on. See [Routing methods](#routing-methods) below for the complete list.

Route paths match the complete request path for a route. Unlike [app.use()](#appuse), a route path
does not match path prefixes by default. For example, `app.get('/apple', ...)` matches "/apple" but
not "/apple/images" unless the path pattern is written to match that longer path.

#### Routing methods

Express supports the following routing methods corresponding to the HTTP methods of the same names:
Expand Down Expand Up @@ -1041,9 +1049,10 @@ it is usually better to use [req.baseUrl](/api/request/#reqbaseurl) to get the c
<Signature>
<Fragment slot="attributes">
<Param name="path" type="String | RegExp | Array">
The path for which the middleware function is invoked; can be any of: a string representing a
path, a path pattern, a regular expression pattern to match paths, or an array of combinations
of any of the above. For examples, see [Path examples](#path-examples).
The path for which the route callback is invoked; can be any of: a string representing a path,
a path pattern, a regular expression pattern to match paths, or an array of combinations of
any of the above. Route paths match complete request paths; for syntax examples, see [Path
examples](#path-examples).
</Param>
<Param name="callback" type="Function | Function[]">
Callback functions; can be: a middleware function, a series of middleware functions (separated
Expand Down Expand Up @@ -1083,9 +1092,10 @@ app.post('/', (req: Request, res: Response) => {
<Signature>
<Fragment slot="attributes">
<Param name="path" type="String | RegExp | Array">
The path for which the middleware function is invoked; can be any of: a string representing a
path, a path pattern, a regular expression pattern to match paths, or an array of combinations
of any of the above. For examples, see [Path examples](#path-examples).
The path for which the route callback is invoked; can be any of: a string representing a path,
a path pattern, a regular expression pattern to match paths, or an array of combinations of
any of the above. Route paths match complete request paths; for syntax examples, see [Path
examples](#path-examples).
</Param>
<Param name="callback" type="Function | Function[]">
Callback functions; can be: a middleware function, a series of middleware functions (separated
Expand Down Expand Up @@ -1124,9 +1134,10 @@ app.put('/', (req: Request, res: Response) => {
<Signature runtime={{ 'Node.js': '>=20.19.3 <21 || >=22.2.0' }}>
<Fragment slot="attributes">
<Param name="path" type="String | RegExp | Array">
The path for which the middleware function is invoked; can be any of: a string representing a
path, a path pattern, a regular expression pattern to match paths, or an array of combinations
of any of the above. For examples, see [Path examples](#path-examples).
The path for which the route callback is invoked; can be any of: a string representing a path,
a path pattern, a regular expression pattern to match paths, or an array of combinations of
any of the above. Route paths match complete request paths; for syntax examples, see [Path
examples](#path-examples).
</Param>
<Param name="callback" type="Function | Function[]">
Callback functions; can be: a middleware function, a series of middleware functions (separated
Expand Down Expand Up @@ -1560,7 +1571,7 @@ the middleware function is executed when the base of the requested path matches

#### Description

A route will match any path that follows its path immediately with a "`/`".
Middleware mounted with `app.use()` will match any path that follows its path immediately with a "`/`".
For example: `app.use('/apple', ...)` will match "/apple", "/apple/images",
"/apple/images/news", and so on.

Expand Down
Loading