Реализация маршрутизации API в PHP: методы и практические советы

Раздел: Веб-разработка на PHP -> Роутинг в PHP

Маршрутизация API в PHP: обзор подходов

Маршрутизация (роутинг) определяет, какой код выполняется при обращении к определённому URL и HTTP-методу. Для API это критически важно: каждый эндпоинт должен быть сопоставлен с обработчиком. Рассмотрим несколько способов реализации, от простых до профессиональных.

Как реализовать маршрутизацию с помощью FastRoute?

Наиболее эффективное решение для standalone PHP-проекта - библиотека FastRoute (автор Nikic). Она обеспечивает высокую производительность, поддержку параметров, групп и middleware.

Установка

composer require nikic/fast-route

Ru index php route account order (маршрут заказа аккаунта (ru))

Базовая конфигурация


$dispatcher = FastRoute\simpleDispatcher(function(FastRoute\RouteCollector $r) {
    $r->addRoute('GET', '/users', 'getUsers');
    $r->addRoute('GET', '/users/{id:\d+}', 'getUser');
    $r->addRoute('POST', '/users', 'createUser');
    $r->addRoute('PUT', '/users/{id}', 'updateUser');
    $r->addRoute('DELETE', '/users/{id}', 'deleteUser');
});

Php route product manufacturer (маршрут php для продукта производителя)

Обработка запроса


$httpMethod = $_SERVER['REQUEST_METHOD'];
$uri = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);

$routeInfo = $dispatcher->dispatch($httpMethod, $uri);
switch ($routeInfo[0]) {
    case FastRoute\Dispatcher::NOT_FOUND:
        header('HTTP/1.1 404 Not Found');
        echo json_encode(['error' => 'Route not found']);
        break;
    case FastRoute\Dispatcher::METHOD_NOT_ALLOWED:
        header('HTTP/1.1 405 Method Not Allowed');
        echo json_encode(['error' => 'Method not allowed']);
        break;
    case FastRoute\Dispatcher::FOUND:
        $handler = $routeInfo[1];
        $params = $routeInfo[2];
        echo call_user_func($handler, $params);
        break;
}

Class route php (класс маршрутизации в php)

Результат при запросе GET /users/123

{"id":123,"name":"John"}

Php route login (маршрут входа в php)

Проблемы: Необходимо самостоятельно обрабатывать ошибки 404/405. При большом количестве маршрутов файл конфигурации может стать громоздким. Решение - группировка маршрутов и вынос обработчиков в отдельные классы.

Типичная ошибка: Некорректное регулярное выражение в параметре {id:\d+} - может привести к тому, что маршрут не совпадёт. Рекомендуется всегда указывать шаблон для числовых идентификаторов.

Как организовать простейшую маршрутизацию без сторонних библиотек?

Если проект совсем мал или не требует composer, можно обойтись анализом $_SERVER['REQUEST_URI'] с помощью switch или if.


$uri = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);
$method = $_SERVER['REQUEST_METHOD'];

switch (true) {
    case $uri === '/api/users' && $method === 'GET':
        // список пользователей
        break;
    case preg_match('#^/api/users/(\d+)$#', $uri, $matches) && $method === 'GET':
        $userId = $matches[1];
        // один пользователь
        break;
    default:
        http_response_code(404);
        echo 'Not Found';
}

Routing api php (маршрутизация api в php)

Проблемы: Код быстро разрастается, сложно поддерживать, нет автоматической проверки HTTP-методов. Решение - структурировать маршруты в массиве и обходить их циклом.

Как извлечь параметры из URL при маршрутизации с помощью регулярных выражений?

Регулярные выражения позволяют захватывать динамические сегменты URI. Определяем массив маршрутов с шаблонами и соответствующими обработчиками.


$routes = [
    'GET' => [
        '#^/api/posts/(\d+)$#' => 'getPost',
        '#^/api/posts$#' => 'getPosts',
    ],
];

$matched = false;
foreach ($routes[$method] as $pattern => $handler) {
    if (preg_match($pattern, $uri, $matches)) {
        array_shift($matches); // убираем полное совпадение
        $matched = true;
        echo call_user_func($handler, $matches);
        break;
    }
}
if (!$matched) {
    http_response_code(404);
}

Проблемы: Скорость ниже по сравнению с компилируемыми маршрутизаторами; сложность поддержки вложенных групп. Решение - кеширование разобранных маршрутов.

Как быстро развернуть API на микрофреймворке Slim?

Микрофреймворк Slim (версия 4) предоставляет полный набор для построения API: маршрутизация, middleware, контейнер зависимостей.


use Slim\Factory\AppFactory;

require __DIR__ . '/../vendor/autoload.php';

$app = AppFactory::create();

$app->get('/api/users', function ($request, $response) {
    $data = ['users' => [['id' => 1, 'name' => 'Alice']]];
    $response->getBody()->write(json_encode($data));
    return $response->withHeader('Content-Type', 'application/json');
});

$app->get('/api/users/{id}', function ($request, $response, $args) {
    $userId = $args['id'];
    // ...
});

$app->run();

Проблемы: Излишняя абстракция для очень простых проектов; необходимость изучения фреймворка. Решение - выбрать Slim только если планируется рост функциональности.

Как использовать компонент Symfony Routing в standalone проекте?

Компонент symfony/routing можно установить отдельно и использовать для загрузки маршрутов из разных форматов (YAML, аннотации).


use Symfony\Component\Routing\Loader\YamlFileLoader;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Routing\Router;

$locator = new FileLocator([__DIR__ . '/config']);
$router = new Router(
    new YamlFileLoader($locator),
    'routes.yaml'
);

$router->getRouteCollection();
// далее анализ URI через $router->match()

Пример файла routes.yaml:


api_users_get:
    path: /api/users/{id}
    controller: App\Controller\UserController::get
    methods: GET

Проблемы: Необходимость интеграции с контейнером для вызова контроллеров, настройка кеширования. Решение - использовать в паре с symfony/http-kernel.

Расширенные примеры маршрутизации API

FastRoute: группы, middleware, обработка ошибок

Группировка маршрутов с общим префиксом и middleware (допустим, проверка API-ключа):

Пример


$dispatcher = FastRoute\simpleDispatcher(function(FastRoute\RouteCollector $r) {
    $r->addGroup('/api/v1', function (FastRoute\RouteCollector $r) {
        $r->addRoute('GET', '/users', 'apiUsers');
        $r->addRoute('POST', '/users', 'apiCreateUser');
    });
});

// Middleware в обработчике
function apiUsers($params) {
    // проверка ключа
    if (!validateApiKey()) {
        http_response_code(401);
        return json_encode(['error' => 'Unauthorized']);
    }
    return json_encode(['users' => []]);
}

Результат запроса GET /api/v1/users без ключа:

HTTP/1.1 401 Unauthorized
{"error":"Unauthorized"}

Регулярные выражения с множественными параметрами

Маршрут для получения комментариев к посту: /api/posts/{postId}/comments/{commentId}

Пример


$routes['GET']['#^/api/posts/(\d+)/comments/(\d+)$#'] = function($params) {
    list(, $postId, $commentId) = $params;
    return json_encode(['post' => $postId, 'comment' => $commentId]);
};

При запросе GET /api/posts/12/comments/5 результат:

{"post":12,"comment":5}

Symfony Routing: загрузка из XML с кешированием

Использование кеша через RouterCacheWarmer:

Пример


use Symfony\Component\Routing\Matcher\UrlMatcher;
use Symfony\Component\Routing\RequestContext;
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Route;

$routes = new RouteCollection();
$route = new Route('/api/items/{id}', ['controller' => 'getItem']);
$route->setMethods(['GET']);
$routes->add('get_item', $route);

$context = new RequestContext('/');
$matcher = new UrlMatcher($routes, $context);

try {
    $parameters = $matcher->match('/api/items/42');
    echo '' . print_r($parameters, true) . '';
} catch (ResourceNotFoundException $e) {
    echo '404';
}

Результат:

Array
(
    [id] => 42
    [controller] => getItem
    [_route] => get_item
)

Обработка 404 и 405 с кастомным ответом

Пример


// FastRoute + middleware для JSON-ответа
$dispatcher->dispatch($httpMethod, $uri);
switch ($routeInfo[0]) {
    case FastRoute\Dispatcher::NOT_FOUND:
        $response = ['status' => 404, 'message' => 'Endpoint does not exist'];
        break;
    case FastRoute\Dispatcher::METHOD_NOT_ALLOWED:
        $allowedMethods = $routeInfo[1];
        $response = ['status' => 405, 'message' => 'Allowed methods: ' . implode(', ', $allowedMethods)];
        break;
}
http_response_code($response['status']);
echo json_encode($response);

Динамический вызов контроллеров (FastRoute + autoload)

Пример


$dispatcher->addRoute('GET', '/users', ['App\Controller\UserController', 'listAction']);
// в диспетчере
case FastRoute\Dispatcher::FOUND:
    list($class, $method) = $handler;
    $controller = new $class();
    echo call_user_func([$controller, $method], $params);

Маршрутизация API в PHP - comments

Routing api php (php)