Версионирование и изменения
BreakingBet API постоянно развивается, и для сохранения обратной совместимости мы применяем версионирование API.
Как будут добавляться новые возможности
Если изменение не затрагивает обратную совместимость (например, добавление новых полей), оно может быть внесено в текущую версию без необходимости обновления клиента.
Нарушение обратной совместимости
Если изменение нарушает обратную совместимость, применяется следующий порядок:
- Запускается новая версия API.
- Предыдущая версия продолжает работать не менее 2 месяцев.
- В течение этого времени:
- обе версии доступны параллельно,
- пользователи могут перейти на новую версию в удобном режиме.
По истечении периода поддержки старая версия может быть отключена.
Поддержка старых версий
На период параллельной поддержки:
- документация будет доступна для каждой версии,
- Swagger UI будет привязан к конкретной версии API,
- поведение версий не будет меняться без объявления.
Как узнавать об изменениях
Информация об изменениях API будет публиковаться:
- в документации,
- через официальные каналы коммуникации BreakingBet.
Рекомендация
Рекомендуется следить за обновлениями и закладывать возможность обновления версии API в клиентском коде.