РекомендуетсяOpenAPI

Контракты компонентов

Опишите вход, выход, ошибки и права, когда несколько частей системы взаимодействуют.

Проверено Изменено

Плохо

Frontend ждёт price.
Backend отдаёт amount.

Хорошо

Контракт: amountMinor + currency.
Обе стороны проверяют один контракт.

Почему это важно

Несогласованные интерфейсы ломают интеграцию даже при работающих отдельных модулях.

Когда применять

Для внешних границ и совместной разработки. Внутренней функции не всегда нужен OpenAPI.

Кто что делает

Человек

Согласует вход, выход, ошибки и владельцев границ.

AI-агент

Изучает существующий код, предлагает минимальное решение и связывает изменения с критериями приёмки.

Контроль результата:

  • Есть ли пример успешного ответа и ошибки?

Как проверить у себя

  • Есть ли пример успешного ответа и ошибки?
ПервоисточникиИстория изменений на GitHub

Дата проверки отражает содержательную сверку. Синхронизация сайта не обновляет её автоматически.