Выполнение проверок · Средняя
Как проверить API-контракты
Убедиться, что frontend и backend одинаково понимают структуру запросов, ответов, ошибок и ограничений.
Кратко: за 2 минуты
Убедиться, что frontend и backend одинаково понимают структуру запросов, ответов, ошибок и ограничений. На выходе: критичные endpoint проверены по контракту.
Когда применять
Пункт относится к этапу «Выполнение проверок». Его задача — превратить рабочее действие в проверяемый результат. Он нужен до передачи результата разработчикам, менеджеру и владельцу продукта: иначе команда рискует проверять только успешный ответ 200.
Что это дает
Проверка API-контрактов снижает риск ситуаций, когда интерфейс ломается не из-за логики, а из-за несовпадения формата данных или обработки ошибок.
Пошагово: как выполнить
- Сравните фактический ответ API с документацией или OpenAPI-схемой.
- Проверьте обязательные поля, типы данных, коды ошибок, пустые ответы и права доступа.
- Зафиксируйте расхождения как дефекты или вопросы к контракту.
Критерии приемки
- Критичные endpoint проверены по контракту.
- Ошибки и пустые состояния возвращаются в ожидаемом формате.
- Расхождения между документацией и фактом исправлены или согласованы.
Типичные ошибки
- Проверять только успешный ответ 200.
- Игнорировать ошибки авторизации и валидации.
- Не проверять совместимость после изменения API.
Инструменты
Пример
Плохой пример
Проверять только успешный ответ 200.
Хороший пример
Учебный пример. Ответ GET /orders содержит обязательный status и массив items. Тест обнаруживает смену массива на объект, хотя HTTP-статус остается 200; несовместимость связывается с опубликованной версией схемы.
Шаблон
Набор контрактных проверок
Скачать рабочий лист этого урока
Выбрать рабочий шаблонРабочий артефакт
Test run
Набор контрактных проверок
Учебный пример. Ответ GET /orders содержит обязательный status и массив items. Тест обнаруживает смену массива на объект, хотя HTTP-статус остается 200; несовместимость связывается с опубликованной версией схемы.
- Passed
- Failed
- Blocked
- Retest
Контроль качества
Отчет выполнения тестов
Критичные endpoint проверены по контракту.
После релизов, изменения требований, новых дефектов, ретестов и обновления критериев приемки.
Риск, шаги воспроизведения, окружение, доказательства, ожидаемый результат и владельца исправления.
Перед отметкой выполнено: Критичные endpoint проверены по контракту.
Как применять
Начинайте с риска для пользователя и продукта. Затем проверьте воспроизводимость, окружение, тестовые данные и доказательства. Хороший QA-пункт отвечает на три вопроса: какой риск закрываем, как воспроизводим результат и по каким критериям считаем проверку завершенной.
Короткие ответы
Частые вопросы
Зачем выполнять пункт «Как проверить API-контракты»?
Проверка API-контрактов снижает риск ситуаций, когда интерфейс ломается не из-за логики, а из-за несовпадения формата данных или обработки ошибок.
С чего начать выполнение?
Сравните фактический ответ API с документацией или OpenAPI-схемой.
Как понять, что пункт выполнен?
Критичные endpoint проверены по контракту.
Какая ошибка чаще всего мешает результату?
Проверять только успешный ответ 200.
Режим обучения
Тест по теме
Проверка понимания
Ответьте на вопросы по материалу и получите итоговый отчет: что понято хорошо, а что стоит перечитать.
Для углубленного изучения
Редакция Ariol · Версия 2 · Обновлено
Независимая экспертная проверка не заявлена.
Что обновлено
- — Обновлено: Название, Шаблон результата, Пример, Плохой пример, Заголовок поиска, Описание поиска, Поисковые фразы.
Материал предназначен для обучения. Адаптируйте рекомендации к внутренним регламентам компании и условиям проекта.
Предложить исправление через контакты Ariol