Почему важно кэшировать REST API в WordPress
REST API является мощным инструментом для взаимодействия с WordPress из внешних приложений, мобильных клиентов и фронтенд-фреймворков. Однако, при большом трафике REST API может создавать значительную нагрузку на сервер, особенно при частых запросах, которые генерируют одинаковые данные. Кэширование ответов API позволяет существенно снизить нагрузку, повысить скорость отклика и улучшить пользовательский опыт.
WP Super Cache — один из самых популярных плагинов для кэширования страниц WordPress. По умолчанию он не кэширует REST API запросы, так как они обычно динамические и требуют актуальных данных. Но в ряде случаев, например, для публичных данных, кэширование REST API выгодно и необходимо. В этой статье мы подробно рассмотрим, как правильно настроить кэширование REST API с WP Super Cache, а также как исключить из кэша нужные эндпоинты.
Обратите внимание, что для кэширования REST API важно понимать, какие запросы можно кэшировать, чтобы не нарушить логику сайта и не выдавать устаревшие или персонализированные данные.
Включение кэширования REST API в WP Super Cache
По умолчанию WP Super Cache игнорирует запросы, начинающиеся с /wp-json/ — это путь REST API. Чтобы включить кэширование, нужно изменить правила исключений. Сделать это можно двумя способами: через настройки плагина или добавлением фильтров в functions.php вашей темы.
Изменение настроек исключений в WP Super Cache
Перейдите в админку WordPress в раздел Настройки > WP Super Cache > Advanced. В блоке Rejected URIs обычно присутствует правило, которое исключает из кэша URI, содержащие wp-json. Удалите или закомментируйте эту строку, чтобы разрешить кэширование REST API.
Однако такой подход не всегда безопасен, так как некоторые эндпоинты требуют актуальности данных, например, авторизация, пользовательские данные и т.д. Поэтому лучше использовать программные фильтры для тонкой настройки.
Использование фильтра для включения кэширования REST API
Добавьте в functions.php вашей активной темы следующий код, который позволит кэшировать только публичные REST API запросы:
function wpsupercache_allow_restapi_cache( $cache, $url ) {
// Проверяем, что URL содержит wp-json
if ( strpos( $url, '/wp-json/' ) !== false ) {
// Вы можете добавить здесь логику для исключения определенных эндпоинтов
// Например, кэшируем только GET запросы к публичным данным
if ( $_SERVER['REQUEST_METHOD'] !== 'GET' ) {
return false; // не кэшируем POST, PUT, DELETE
}
// Исключаем эндпоинты с авторизацией
if ( preg_match('#/wp-json/wp/v2/users#', $url) ) {
return false; // не кэшируем данные пользователей
}
// В остальных случаях разрешаем кэширование
return true;
}
return $cache;
}
add_filter( 'wpsupercache_cache_for_url', 'wpsupercache_allow_restapi_cache', 10, 2 );Этот фильтр проверяет, что запрос является GET к REST API, и исключает чувствительные кэшируемые данные, например, пользователей. При необходимости вы можете расширить регулярные выражения для других эндпоинтов.
Управление временем жизни кэша для REST API
REST API данные могут быстро устаревать, поэтому важно контролировать TTL (time to live) кэша. В WP Super Cache время жизни кэша по умолчанию составляет 3600 секунд (1 час). Для REST API вы можете задать другое время жизни, чтобы обеспечить баланс между производительностью и актуальностью.
Для этого добавьте следующий код в functions.php:
function wpsupercache_restapi_cache_timeout( $timeout, $url ) {
if ( strpos( $url, '/wp-json/' ) !== false ) {
// Устанавливаем TTL для REST API в 5 минут
return 300;
}
return $timeout;
}
add_filter( 'wpsupercache_cache_timeout', 'wpsupercache_restapi_cache_timeout', 10, 2 );Таким образом, кэш для REST API будет обновляться каждые 5 минут, что достаточно для большинства публичных данных.
Пример исключения из кэша динамического контента в REST API
Иногда в REST API возвращается динамический контент, например, результаты поиска или персонализированные данные. Их кэшировать нельзя, иначе пользователи увидят чужие данные.
Допустим, вы хотите исключить из кэша все запросы, содержащие параметр search:
function wpsupercache_exclude_search_from_cache( $cache, $url ) {
if ( strpos( $url, '/wp-json/' ) !== false && isset( $_GET['search'] ) ) {
return false; // отключаем кэширование
}
return $cache;
}
add_filter( 'wpsupercache_cache_for_url', 'wpsupercache_exclude_search_from_cache', 20, 2 );Таким образом, все запросы с параметром search не будут кэшироваться, что гарантирует актуальность результатов.
Интеграция с другими плагинами и инструментами
Если вы используете WP Super Cache совместно с плагинами оптимизации, например, Clearfy Pro или WPGPT, убедитесь, что кэширование REST API не конфликтует с их функционалом. Иногда плагины предоставляют собственные фильтры для управления кэшем, которые можно использовать вместе с WP Super Cache.
Также для продвинутого кэширования REST API можно рассмотреть использование Redis или Memcached, но это требует дополнительной настройки на сервере и совместимости с WP Super Cache. Подробнее о настройке Redis с WP Super Cache вы можете прочитать в нашей статье WP Super Cache и Redis: как настроить и оптимизировать кэширование для WordPress.
Проверка и отладка кэширования REST API
Для проверки, кэшируется ли ваш REST API запрос, рекомендуем использовать инструменты разработчика в браузере и проверять заголовки ответа. При кэшировании WP Super Cache добавляет заголовок X-Cache со значением HIT или MISS.
Например, выполните запрос к API через curl:
curl -I https://example.com/wp-json/wp/v2/posts/В ответе ищите заголовок X-Cache: HIT — это означает, что ответ взят из кэша. Если вы видите MISS, значит кэш не используется.
Для отладки фильтров кэширования удобно добавлять логирование в файл debug.log:
function wpsupercache_debug_cache_for_url( $cache, $url ) {
if ( strpos( $url, '/wp-json/' ) !== false ) {
error_log( "[wpsupercache] REST API caching for URL: $url - " . ( $cache ? 'YES' : 'NO' ) );
}
return $cache;
}
add_filter( 'wpsupercache_cache_for_url', 'wpsupercache_debug_cache_for_url', 30, 2 );Это поможет понять, какие запросы кэшируются, а какие нет.
Резюме: основные рекомендации по кэшированию REST API с WP Super Cache
- Разрешите кэширование только для безопасных GET запросов.
- Исключайте из кэша эндпоинты с персональными или динамическими данными.
- Устанавливайте отдельный TTL для REST API, чтобы балансировать между скоростью и актуальностью.
- Используйте фильтры WP Super Cache для точной настройки кэширования.
- Проверяйте работу кэша через заголовки ответа и логирование.