Версионирование и вывод API из эксплуатации

Узнайте, как Inblog поддерживает API v1, объявляет о будущей отмене и планирует завершение поддержки.

Inblog указывает версию REST API в пути URL, чтобы автоматизация могла использовать предсказуемый контракт.

Текущая поддержка

v1 — текущая поддерживаемая версия REST API. Используйте эндпоинты /api/v1/... и документ OpenAPI при создании интеграций.

В рамках v1 мы сохраняем обратную совместимость для поддерживаемых операций. Дополнительные поля ответа и другие обратно совместимые улучшения могут появляться без создания новой версии URL. Дата отмены или завершения поддержки v1 пока не объявлена.

API сейчас не отправляет заголовки ответа Deprecation или Sunset для v1 только потому, что существует эта политика. Отсутствие этих заголовков означает, что сигнал о выводе версии из эксплуатации не объявлен.

Будущие сигналы жизненного цикла

Если вывод поддерживаемой версии API из эксплуатации будет запланирован, Inblog может использовать следующие заголовки ответа:

  • Deprecation сообщает, что версия устарела, и может содержать дату вступления этого статуса в силу.
  • Sunset сообщает планируемую дату, после которой версия больше не будет поддерживаться.

Это разные сигналы: Deprecation объявляет изменение жизненного цикла, а Sunset указывает планируемое завершение поддержки. Если заголовки присутствуют, сохраняйте оба значения и изучайте связанную документацию или руководство по миграции.

Срок уведомления

Обычно мы предоставляем уведомление минимум за 180 дней до удаления v1 или внесения обратно несовместимого изменения в поддерживаемую версию API. Это консервативный минимум, а не обещание, что каждое изменение будет выполнено строго по такому графику.

Уязвимость безопасности, требование закона или чрезвычайная ситуация могут потребовать более короткого уведомления или немедленного изменения. В таких условиях мы сообщим о последствиях и доступных способах исправления как можно раньше.

Рекомендации для клиентов

  • Фиксируйте запросы на /api/v1, а не определяйте версию по заголовкам ответа.
  • Считайте добавленные поля обратно совместимыми и игнорируйте поля, которые клиент не использует.
  • При планировании миграции отслеживайте заголовки Deprecation и Sunset, заметки о выпуске и эту политику.
  • Используйте документ OpenAPI как машиночитаемый источник текущего контракта.

Связанные ссылки

Последнее обновление 2026-08-25