🔖 Стандартные headers для кэш в REST API - полный гайд в одной картинке 🔖

Чтобы управлять кэшированием в REST API, необходимо использовать специальные HTTP-заголовки (headers).

Именно эти технические параметры говорят браузеру, CDN и прокси:
• можно ли отдавать кэшированную копию,
• нужно ли проверять свежесть у origin (вашего сервера/приложения),
• сохранять ли ответ в кэше и на сколько.

Системному аналитику, при постановке задачи на разработчиков, нужно учесть необходимые headers в дизайне (контракте) REST API метода и описать их поведение в алгоритме его работы.


Request headers - Заголовки запросов:
🔑 Cache-Control
🔑 Pragma
If-None-Match
If-Modified-Since
If-Match
If-Unmodified-Since
If-Range

Response headers - Заголовки ответов:
🔑 Cache-Control
🔑 Expires
🔑 ETag
🔑 Last-Modified
🔑 Vary
🔑 Age
🔑 Date
🔑 Cache-Status
Content-Location
Warning
Surrogate-Control
Surrogate-Key
X-Cache / CF-Cache-Status / X-Served-By

Ключами 🔑 отмечены те, которые желательно знать и помнить.
Остальные - всегда можно подсмотреть при необходимости.


👉 Детали по каждому header, пояснения и примеры собраны в гайде - на картинке к посту.


🔖 Сохраняйте пост и делитесь с командой - это ваш чек-лист перед стартом работы с REST API методами, где нужно подключить кэширование.


P.S. Вопросы про кэширование в API в последнее время стали чаще задавать на собеседованиях для senior-аналитиков на проекты с высоконагружеными системами

#RestApiGA