Простыми словами
Сначала команда описывает будущий API как формальный контракт - какие запросы, поля и ответы существуют. Уже после этого сервер и клиенты реализуют контракт независимо, а документацию и проверки можно строить вокруг одной схемы.
Пример при разработке
В проекте команда фиксирует практику «Проектирование API от схемы» как отдельное правило, добавляет автоматическую проверку и наблюдаемый критерий результата.
Это редакционный пример применения, а не часть определения или доказательство концепции.Формальное определение
Схема API создаётся до реализации и служит общим контрактом для серверов, клиентов, документации и тестов.
Механизм действия
Для «Проектирование API от схемы» команда задаёт явные границы, проверяемый контракт и сигнал, по которому видно соблюдение или нарушение правила.
Пример в работе
Использовать «Проектирование API от схемы» как термин без владельца, критерия и проверки реального поведения.
Связать «Проектирование API от схемы» с конкретным риском, тестом или метрикой и пересматривать правило при изменении контекста.
Ограничения
Практика «Проектирование API от схемы» решает ограниченную задачу и не заменяет анализ всей системы, проверку исходных допущений и измерение побочных эффектов.
Источник
GraphQL Foundation, “GraphQL Specification”, 2021.