минимальный чеклист корректного запроса
Текст термина (дословно из источника)
Минимальный чеклист - это короткая последовательность проверок перед отправкой команды.
Простыми словами: это "обязательный контроль качества" запроса.
Чеклист:
- URL
- Указан правильный протокол (
https://), домен и путь. - Query-параметры соответствуют задаче.
- Метод
- Выбран метод, соответствующий операции (
GET,POST,PUT/PATCH,DELETE).
- Заголовки
- Проставлены только нужные заголовки.
- Для body задан корректный
Content-Type. - Для ожидаемого формата ответа задан
Accept(при необходимости).
- Body
- Передается только там, где это требуется.
- Формат body валиден и согласован с
Content-Type.
- Авторизация
- Выбран правильный способ доступа (Bearer, Basic, API key).
- Секреты не попадают в URL и не публикуются в открытом виде.
- Диагностика
- Для проблемных запросов включены
-i/-v, при необходимости настроены таймауты и retry.
- Воспроизводимость
- Команда минимальна, понятна и повторяема другим участником команды.
Практический вывод:
- Шаблоны ускоряют старт, но всегда требуют адаптации под конкретный API-контракт.
- Чеклист снижает число ошибок перед запуском и делает результат предсказуемым.