Руководство разработчика

Интеграция верификации в пайплайн CI/CD

Пошаговое руководство по внедрению автоматической проверки контрактов API и конфигураций. От локального запуска до автоматического отката в продакшене.

Скачать плагин Полная документация
Схема работы пайплайна с интеграцией Verifly

Зачем проверять код до продакшена

Согласно отчету DevOps Research and Assessment (DORA) 2023 года, 40% инцидентов высокой критичности происходят из-за несоответствия контрактов между микросервисами.

Традиционные методы тестирования (Unit, Integration) часто пропускают ошибки валидации сложных JSON-схем или конфигурационных файлов при деплое в новую среду. Verifly решает эту проблему, внедряя "Gatekeeper" — шлюз валидации, который блокирует билд, если обнаруживает отклонения в структуре данных.

Интеграция занимает менее 15 минут и снижает риск "сломанного API" на 98%.

Шаг 1: Установка плагина

Поддержка для Jenkins, GitHub Actions, GitLab CI и TeamCity из коробки.

📦

GitHub Actions

Добавьте шаг в ваш .github/workflows/deploy.yml:

- name: Run Verifly Validation
  uses: verifly/action@v2
  with:
    api-key: ${{ secrets.VFLY_KEY }}
🔧

Jenkins Pipeline

Установите плагин "Verifly Validator" через UI и добавьте в скрипт:

stage('Verify') {
  steps {
    veriflyCheck(project: 'backend-api')
  }
}
🐳

CLI / Docker

Используйте официальный образ для любой среды:

docker run verifly/cli:latest \
  --schema ./schema.json \
  --target http://localhost:8080

Шаг 2: Настройка правил валидации

Определите границы допустимых изменений с помощью файлов конфигурации .veriflyrc.

Вы можете настроить строгие правила (Strict Mode), которые не пропустят даже удаление необязательного поля, или гибкие (Smart Mode), которые учитывают версию API.

Пример конфигурации для защиты платежного модуля:

  • ➤ Schema Drift: Запрет на изменение типов данных в полях `amount` и `currency`.
  • ➤ Latency Check: Отклонение билда, если время ответа эндпоинта превышает 200мс.
  • ➤ Auth Rules: Проверка наличия заголовков авторизации во всех публичных методах. 
{
  "rules": [
    {
      "endpoint": "/payments",
      "method": "POST",
      "body": {
        "amount": { "type": "number" },
        "currency": { "enum": ["RUB", "USD"] }
      }
    }
  ]
}

Шаг 3: Обработка ошибок и откат

Сценарий: Обнаружен Breaking Change

Если верификация не пройдена, пайплайн останавливается на этапе VERIFY. Verifly автоматически генерирует отчет об ошибках в формате JSON и отправляет уведомление в Slack/Telegram канал команды разработки.

Автоматический откат (Rollback)

Для интеграции с Kubernetes можно настроить триггер: если Verifly возвращает статус FAIL на пост-деплой проверке, Helm Chart автоматически откатывает релиз к предыдущей стабильной версии.

Результаты бенчмаркинга

Влияние Verifly на скорость и надежность CI/CD процессов (данные тестов на базе монолита 500к строк кода).

+0.4s
Рост времени билда
-85%
Ошибок на QA
0
False Positives
24/7
Мониторинг

Готовы сделать ваш пайплайн неуязвимым?

Начните использовать Verifly бесплатно для открытых проектов. Никаких кредитных карт.

Начать интеграцию