Отслеживание API / даже изменений между различными версиями микросервиса перед развертыванием

Question

Я работаю с devops в довольно крупной компании, которая находится в процессе перехода на микросервисы.Это новая область для большинства вовлеченных людей, и некоторые из управляющих запросов кажутся мне плохой практикой, но у меня нет опыта, чтобы убедить в этом.

Запрос состоит в том, чтобы создать отчет перед его развертыванием.Перечислите любые новые API / события (Kafka - это наша служба обмена сообщениями) в микросервисе.

Рекомендуемый путь для разработчиков - следовать руководству по стилю, а затем очищать исходный код во время конвейера CI / CD для генерацииотчет, который можно сравнить с предыдущими отчетами и определить любые новые API.

Это кажется задом наперед и неустойчивым, но я не смог найти другое решение, которое бы удовлетворило их запросы.Я рекомендовал сначала развернуть dev, а затем использовать инструмент трассировки для определения любых изменений API или подписок на события, но они настаивают на том, чтобы иметь отчет перед развертыванием.

Надеюсь на любые советы по передовой практике.чтобы сделать это.

Answer 1

Отслеживание и обнаружение изменений версии, безусловно, закончилось разработкой.Упрощенно, как упомянул @zenwraight, - это версия вашего API.Хотя прослеживание сервисов для изучения различных версий и схем может быть потенциальным решением, оно требует гораздо больших предварительных инвестиций, и если бы это было не суть компании, я бы предпочел использовать продукт поставщика, который мог бы поддерживать что-то подобное.

Если обнаружение является необходимым механизмом, я бы порекомендовал что-то, что публикует внутренние документы API с помощью такого инструмента, как Swagger, чтобы вы могли искать, есть ли API, который вы можете использовать.

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