Открытая образовательная платформа Ariol
API для аналитика
Как описать API contract: операции, поля, ограничения, ошибки и проверка договора между потребителем и поставщиком API.
Как изучать тему
Контракт начинается с бизнес-операции: кто ее вызывает, какие данные передает и какое состояние получает. Зафиксируйте обязательность полей, ограничения, права доступа и ответы для ошибок. После описания проверьте пример запроса и ответа вместе с разработчиком и QA: они должны одинаково понимать правила и исключения.
Продолжить обучение
Пройдено 0 из 6. Прогресс сохраняется в этом браузере.
Продолжить: Как построить модель предметной областиУроки по порядку
- Как построить модель предметной области
Согласовать сущности, связи, жизненный цикл и единый словарь данных. Результат работы — Domain Model.
- Как спроектировать API-контракт
Согласовать ресурсы, методы, схемы данных и поведение интеграции до разработки. Результат работы — OpenAPI Specification.
- Как описать ошибки и идемпотентность API
Сделать поведение интеграции предсказуемым при валидации, повторах и частичных сбоях. Результат работы — Error Catalog.
- Как сформулировать acceptance criteria
Определить наблюдаемые условия, при которых пользовательский сценарий считается реализованным. Результат работы — Acceptance Criteria Set.
- Как провести контрактное согласование
Проверить совместимость требований между бизнесом, frontend, backend, QA и внешними системами. Результат работы — Contract Review Protocol.
- Как оценить влияние изменения
До согласования изменения определить затронутые процессы, данные, контракты, сроки и риски. Результат работы — Impact Analysis.
Практическое задание
Опишите создание заказа: успешный ответ, отсутствие обязательного поля и отказ в доступе. Для каждого сценария укажите код ответа, структуру тела и дальнейшее действие клиента.
Как оценить результат