Как безопасно эволюционировать контракты между сервисами?

Безопасная эволюция контрактов между сервисами достигается за счёт принципов обратной совместимости и постепенного внедрения изменений. Основные подходы:

• Версионирование контрактов: добавление новой версии API или схемы, при этом старые версии продолжают работать.
• Добавление новых полей как опциональных: не удалять и не менять существующие поля, а расширять контракт новыми необязательными параметрами.
• Использование схем с поддержкой эволюции (например, Avro, Protobuf), которые позволяют добавлять новые поля без нарушения старых клиентов.
• Договорённости о поведении при отсутствии новых полей: клиенты должны корректно обрабатывать отсутствие новых данных.
• Тестирование совместимости: автоматические тесты, проверяющие, что новые версии не ломают старые клиенты.

Пример с использованием JSON Schema, где добавлено новое необязательное поле:

from jsonschema import validate, ValidationError

schema_v1 = {
    "type": "object",
    "properties": {
        "id": {"type": "integer"},
        "name": {"type": "string"}
    },
    "required": ["id", "name"]
}

schema_v2 = {
    "type": "object",
    "properties": {
        "id": {"type": "integer"},
        "name": {"type": "string"},
        "email": {"type": "string"}  # новое необязательное поле
    },
    "required": ["id", "name"]
}

# Клиенты, поддерживающие v1, смогут игнорировать поле email, если оно есть

try:
    validate(instance={"id": 1, "name": "Alice"}, schema=schema_v2)  # валидно
    validate(instance={"id": 2, "name": "Bob", "email": "bob@example.com"}, schema=schema_v2)  # валидно
except ValidationError as e:
    print(f"Ошибка валидации: {e}")