Routing

Basic Routing

Routes map URLs to handlers. Define them in routes/web.php:

$app->get('/', function () {
    return 'Hello, World!';
});

$app->post('/users', function () {
    return 'Create user';
});

Available Methods

$app->get('/path', $handler);
$app->post('/path', $handler);
$app->put('/path', $handler);
$app->patch('/path', $handler);
$app->delete('/path', $handler);

Route Parameters

Capture dynamic segments with {parameter}:

$app->get('/users/{id}', function (string $id) {
    return "User: {$id}";
});

$app->get('/posts/{post}/comments/{comment}', function (string $post, string $comment) {
    return "Post {$post}, Comment {$comment}";
});

Parameters are automatically injected into your handler.

Controller Routes

Point routes to controller methods:

use App\Controllers\UserController;

// Array syntax
$app->get('/users', [UserController::class, 'index']);
$app->get('/users/{id}', [UserController::class, 'show']);

// String syntax
$app->get('/users', 'App\Controllers\UserController@index');

Named Routes

Give routes a name for URL generation:

$app->get('/users/{id}', [UserController::class, 'show'])->name('users.show');

Generate URLs:

$url = $app->url('users.show', ['id' => 123]);
// /users/123

Route Groups

Group routes with a common prefix:

$app->group('/api', function ($router) {
    $router->get('/users', [ApiUserController::class, 'index']);
    $router->get('/posts', [ApiPostController::class, 'index']);
});

// Results in:
// GET /api/users
// GET /api/posts

Groups can be nested:

$app->group('/api', function ($router) {
    $router->group('/v1', function ($router) {
        $router->get('/users', [V1UserController::class, 'index']);
    });
});

// GET /api/v1/users

Route Handlers

Routes accept several handler types:

Closures

$app->get('/', function () {
    return 'Hello!';
});

Controller Methods

$app->get('/', [HomeController::class, 'index']);

Invokable Controllers

$app->get('/', HomeController::class);

The controller must have an __invoke method.

Accessing the Request

Handlers receive the PSR-7 request:

use Psr\Http\Message\ServerRequestInterface;

$app->post('/users', function (ServerRequestInterface $request) {
    $data = $request->getParsedBody();
    return "Creating: {$data['name']}";
});