Новая версия API поставщика телеметрии: принять переход собственных приложений без потери смысла данных
Поставщик меняет интерфейс, через который хозяйство получает машинные или полевые наблюдения. Приложение может продолжить получать успешные ответы и при этом иначе понимать время, единицы или полноту истории. Переход следует принимать по контракту данных и результату у всех зависимых потребителей. Замена адреса запроса является только частью работы, если вообще требуется выбранной реализацией.
Найти потребителей и рабочие функции
Составляют перечень интеграций, отчётов, экранов и расчётов, использующих источник. У каждого есть владелец и существенные требования. Зависимость может находиться не только в главном приложении, но и в отдельном сезонном отчёте или выгрузке.
Фиксируют действующий контракт: идентичность объектов, поля, единицы, время, статусы, правила получения частей ответа и исправлений. Важно знать, что означают отсутствующее значение и пустой результат. Подробности реальных прав и ключей остаются в предусмотренных средствах управления, а не в обычном сравнительном документе.
Сопоставить изменения по смыслу
Microsoft рассматривает версии API и изменения, способные нарушить существующих клиентов. Для хозяйства это основание проверять собственное поведение, а не полагаться только на обещание сохранённого формата. Даже добавление сведений требует рассмотрения по фактическому контракту потребителя. (Microsoft Azure Architecture Center — Best practices for RESTful web API design)
Сравнение выделяет изменение имени, типа, единиц, определения показателя и доступного диапазона. Число в том же поле может иметь другой смысл. Аналогично новый порядок выдачи не должен незаметно менять полноту загрузки истории.
Подготовить независимый проверочный набор
В согласованном учебном контуре используют известные примеры, представляющие существенные случаи: обычное наблюдение, пропуск, несколько страниц, исправление и поздние данные. Для каждого определён ожидаемый прикладной результат. Реальные производственные вызовы выполняются только в пределах ранее выданных полномочий соответствующего проекта.
Если две версии возвращают данные за разные моменты, простое различие ответов не доказывает ошибку перехода. Нужно согласовать время и границу сравнения. Кэшированная выдача и обновлённый ряд могут быть разными снимками одного источника.
Проверить весь путь потребителя
Сравнивают получение, преобразование, запись и представление пользователю. Успешное чтение нового формата не подтверждает правильность производных показателей. Особенно полезны случаи на границе отчётного периода и смены состояния, где изменение временного смысла влияет на итог.
Сохраняют версии адаптера и правил преобразования. Если новый источник предоставляет меньше сведений, ограничение остаётся видимым. Временное заполнение отсутствующего поля старым значением не должно выглядеть новым наблюдением без отдельного основания.
Организовать переход и возврат
План определяет момент изменения, обработку уже начатых загрузок и порядок наблюдения за результатом. Повторное получение старого диапазона не должно создавать необъяснённые дубли. Если предусмотрен возврат, подтверждают, что он возможен с учётом уже записанных данных и поддержанного периода старой версии.
Ответственные согласуют условия завершения сравнения и прекращения прежнего способа. Прекращать его только по первому удачному запросу недостаточно. Для неподтверждённых потребителей сохраняют отдельный статус и следующую проверку.
Комплект содержит зависимости, карту изменений, проверочные данные, результаты приложений и порядок перехода. После внедрения фиксируют фактическую версию и известные ограничения. Хозяйство получает управляемое изменение внешнего источника, сохраняя смысл наблюдений и рабочие функции вместо формального совпадения успешных сетевых ответов.