Изменения API
Ломающие изменения, депрекации и версионирование, объяснённые тем, кого они касаются.
-
Версионирование API Stripe: как оно работает и что перенять
Версионирование API Stripe привязывает аккаунт к версии с датой и даёт переопределить её в запросе. Как это работает, чего стоит и что взять малому API.
Изменения API6 мин чтения
-
Breaking changes в Protobuf: что выживает на проводе
Breaking changes в Protobuf происходят на проводе, а не в URL. Одни правки полей gRPC безопасны, другие молча ломают клиентов, а в диффе неотличимы.
Изменения API5 мин чтения
-
Изменения схемы GraphQL: депрекация без номера версии
У GraphQL нет v1 или v2 в URL. Поля депрекируются по одному директивой, на общей схеме, которую используют все клиенты, и это меняет, что должен changelog.
Изменения API5 мин чтения
-
Как написать гайд по миграции API
Гайд по миграции API превращает несовместимое изменение в чек-лист вместо сбоя. Что он должен содержать, и почему одной записи недостаточно.
Изменения API5 мин чтения
-
Внутренние changelog API: что меняется для другой команды
У публичного changelog API аудитория, до которой не дотянуться напрямую. У внутреннего она сидит этажом ниже, и это меняет то, что changelog ей должен.
Изменения API5 мин чтения
-
Заголовок Sunset у API и когда его отправлять
Заголовок Sunset сообщает клиенту API, когда версия перестанет отвечать, в отличие от уведомления о депрекации. Что покрывает RFC 8594 и что даёт brownout.
Изменения API5 мин чтения
-
Changelog вебхуков: breaking change, который никто не просил
Изменение payload вебхука ломается тихо, потому что его некому отклонить. Что делает изменение payload breaking, и как его правильно версионировать.
Изменения API5 мин чтения
-
Changelog API: что публиковать и кто это читает
Changelog API читают те, кто решает, будет ли их код работать через месяц. Что каждая запись им должна, где ей место, и как на неё подписаться.
Изменения API6 мин чтения
-
Как деприкейтить API, не теряя разработчиков
Депрекация — это обещание с датой. Расписание, шаблон уведомления, заголовки ответа, и шаг, не дающий sunset превратиться в инцидент поддержки.
Изменения API5 мин чтения
-
Лучшие практики версионирования API, ради вызывающих
Версионируйте только то, что ломает совместимость, размещайте версию там, где её видят вызывающие, и держите старую до даты. Четыре схемы сравнены.
Изменения API6 мин чтения
-
Breaking changes: что считается и как выпустить
Breaking change это изменение, которое не пережил бы корректный вызывающий. Что считается, что нет, как поймать его в CI и безопасно выпустить.
Изменения API8 мин чтения
