WordPress REST API: отладка и просмотр запросов с примерами

WordPress REST API — мощный инструмент для взаимодействия внешних приложений с вашим сайтом. Однако разработчикам часто приходится сталкиваться с необходимостью отладки и просмотра запросов к API, чтобы понять, что именно возвращает сервер и как обрабатываются данные. В этой статье мы подробно рассмотрим методы отладки REST API в WordPress, включая использование встроенных инструментов и примеры кода для логирования запросов.

Зачем нужна отладка WordPress REST API

REST API позволяет создавать гибкие фронтенд-приложения, мобильные клиенты, а также интегрировать WordPress с другими системами. Но при разработке возникают ситуации, когда ответы API не совпадают с ожиданиями: могут возвращаться ошибки, данные приходят не в том формате или вовсе отсутствуют. Без должной отладки трудно выявить причину проблемы.

Отладка помогает:

• Понять структуру и содержимое запросов и ответов.
• Отследить ошибки и исключения в обработчиках API.
• Проверить корректность авторизации и прав доступа.
• Оптимизировать работу API, выявляя узкие места.

Как просматривать запросы и ответы REST API в WordPress

Использование плагинов для отладки

Для быстрого просмотра запросов к REST API можно использовать плагины, например, REST API Console. Этот плагин позволяет отправлять запросы прямо из админки и видеть ответы сервера.

Еще один полезный инструмент — Query Monitor. Он показывает детали всех запросов, включая REST API, с указанием времени выполнения, используемых хуков и ошибок.

Логирование запросов вручную с помощью кода

Если нужен более детальный контроль, можно добавить логирование запросов REST API прямо в functions.php вашей темы или в собственный плагин. Вот пример функции, которая логирует каждый REST API запрос в отдельный файл:

function wpexamples_log_rest_api_requests(\WP_REST_Request $request) {
    $log_data = [
        'method' => $request->get_method(),
        'route' => $request->get_route(),
        'params' => $request->get_params(),
        'timestamp' => current_time('mysql'),
    ];
    $log_file = WP_CONTENT_DIR . '/rest-api-requests.log';
    file_put_contents($log_file, print_r($log_data, true) . "\n---\n", FILE_APPEND);
}
add_action('rest_api_init', function() {
    add_filter('rest_pre_dispatch', function($response, $server, $request) {
        wpexamples_log_rest_api_requests($request);
        return $response;
    }, 10, 3);
});

Этот код подключает хук rest_pre_dispatch, который срабатывает перед отправкой ответа клиенту, и записывает метод, маршрут, параметры и время запроса в файл wp-content/rest-api-requests.log. Такой лог поможет понять, какие запросы приходят на сайт и с какими параметрами.

Отладка ошибок в REST API: подробный разбор

Частой проблемой при работе с REST API являются ошибки 401 (неавторизован), 403 (запрет доступа) или 500 (внутренняя ошибка сервера). Рассмотрим, как их выявлять и исправлять.

Проверка прав доступа и аутентификации

REST API требует правильной авторизации для защищенных маршрутов. Если пользователь или токен не имеют нужных прав, сервер вернет ошибку. Чтобы проверить права, в callback-функции маршрута можно использовать:

function wpexamples_check_permissions() {
    return current_user_can('edit_posts');
}

И затем в регистрации маршрута прописать параметр 'permission_callback' => 'wpexamples_check_permissions'. Если права не совпадают, API вернет ошибку 403. Для отладки советуем временно разрешить доступ всем, чтобы проверить, отрабатывает ли логика запроса.

Логирование ошибок и исключений

Для отлова неожиданных ошибок используйте PHP-функции error_log() или специальные плагины для логирования. Можно добавить в обработчик API блок try-catch:

function wpexamples_api_handler(\WP_REST_Request $request) {
    try {
        // ваша логика
    } catch (\Exception $e) {
        error_log('REST API error: ' . $e->getMessage());
        return new \WP_Error('rest_api_error', 'Ошибка сервера', ['status' => 500]);
    }
}

Так ошибки будут попадать в лог, и вы сможете быстро их найти.

Полезные плагины для расширенной работы с REST API

Для продвинутых задач рекомендуем обратить внимание на следующие плагины:

• Clearfy Pro — помогает оптимизировать работу сайта, в том числе и REST API, отключая лишние эндпоинты и защищая API от атак. Подробнее на wpshop.ru.
• Expert Review — плагин для сбора отзывов и комментариев через REST API с удобной интеграцией.
• ABC Pagination — расширяет возможности пагинации в REST API, если у вас большой объем данных.

Советы по эффективной отладке REST API в WordPress

Чтобы не терять время на поиск ошибок, придерживайтесь следующих рекомендаций:

• Используйте профессиональные инструменты, такие как Postman или Insomnia, для тестирования запросов.
• Активируйте WP_DEBUG и WP_DEBUG_LOG в файле wp-config.php для записи ошибок в лог.
• Проверяйте права доступа и роли пользователей, особенно при работе с приватными маршрутами.
• Пишите читаемые и структурированные обработчики с понятными ошибками.
• Регулярно чистите и анализируйте логи, чтобы выявлять повторяющиеся проблемы.

Используя описанные методы и примеры, вы сможете быстро и эффективно отлаживать REST API в WordPress, улучшая качество интеграций и расширений.