Path

The path is the first thing Mock Config checks when deciding whether an incoming request matches a route. It is provided as the first argument to any rest.* method.

String Path

Provide a string path to match requests by their pathname:

rest.get('/users', { data: { users: [] } });

This matches any GET request whose pathname is exactly /users. Query parameters are not part of path matching — /users?role=admin still matches /users.

Path Parameters

Use :name to capture dynamic segments of the path:

rest.get('/users/:id', ({ request }) => ({
  id: Number(request.params.id),
  name: 'John'
}));

The captured segment is available on request.params.id as a string. See Path parameters for more.

Wildcards

Use * to match any single path segment:

rest.get('/files/*', { data: null });

This matches /files/report, /files/image.png, and any other single-segment path under /files/.

Regular Expression

Provide a regular expression when you need more control over which paths match:

rest.get(/\/settings\/(profile|billing)/, { data: {} });

This matches /settings/profile and /settings/billing but nothing else under /settings/.

Priority

When multiple routes share the same path pattern, more specific routes — those with a match condition — take priority over less specific ones. Among routes with equal specificity, the one declared first is preferred.

rest.get('/users', [{ id: 1, name: 'John', role: 'admin' }], {
  match: { queries: { role: 'admin' } }
});

rest.get('/users', { data: { users: [] } });