> For the complete documentation index, see [llms.txt](https://quantumphp.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://quantumphp.gitbook.io/docs/packages/router/overview.md).

# Overview

Router defines how requests map to handlers in Quantum modules.

Use it when you need to:

* define routes and route groups
* attach middleware, cache, or rate-limit metadata
* read matched-route data during request handling

## Quick example

```php
return function ($route) {
    $route->get('/', 'HomeController', 'index')->name('home');

    $route->add('signin', 'GET|POST', 'AuthController', 'signin')
        ->middlewares(['Guest'])
        ->rateLimit(10, 60);
};
```

## Pattern support

```php
$route->get('posts/[id=:num]', 'PostController', 'show');
$route->get('invite/[code=:alpha:8]', 'InviteController', 'show');
$route->get('verify/[token=:any]?', 'AuthController', 'verify');
```

Supported parameter types:

* `:alpha` letters only
* `:num` digits only
* `:any` any characters except `/`

## What matters operationally

* Route matching is first-match-wins.
* Group-wide config is best applied by chaining after `group(...)`.
* Route handlers return `Quantum\Http\Response`.
* Short controller names resolve inside the current module; fully-qualified class names opt into an explicit target.
* Controllers are instantiated directly, so action parameters are the right place for DI-backed request values.
* Route names stay unique inside a module.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://quantumphp.gitbook.io/docs/packages/router/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.