Sobes.tech
Back to questions
Middle
5

При каком изменении ответа API мы должны поднимать версионность, а при каких нет?

Companies where asked
WildberriesWildberries

Answer from AI

sobes.tech AI

Версионность API следует повышать при внесении изменений, которые нарушают обратную совместимость (breaking changes). К таким изменениям относятся:

  • Удаление или переименование существующих полей в ответе.
  • Изменение типа данных полей.
  • Изменение структуры ответа, из-за которого клиенты не смогут корректно обработать данные.

Изменения, которые не требуют повышения версии:

  • Добавление новых необязательных полей в ответ (клиенты могут их игнорировать).
  • Добавление новых эндпоинтов.
  • Исправление ошибок, не влияющих на структуру и формат ответа.

Таким образом, если изменения могут сломать существующих клиентов, нужно поднимать версию API.