Тестирование API с Postman — практическое руководство

Что такое API

API (Application Programming Interface) — это соглашение для обмена данными между приложениями. Кратко: API принимает запрос от одной программы и возвращает ответ другой. Если API неработоспособно, пострадает всё приложение, которое от него зависит.

Что такое Postman

Postman — облачная платформа для работы с API: хранит коллекции, версионирует спецификации, помогает создавать документацию, запускать тесты и собирать метрики. Подходит для командной разработки и для работы на разных устройствах. Основные возможности:

• Хранилище спецификаций и коллекций
• Документация и шаринг
• Сценарии рабочих процессов (workflow)
• Ручное и автоматизированное тестирование
• Метрики и мониторинг

Важно: Postman упрощает цикл разработки API, но не заменяет хорошие практики проектирования API и CI/CD.

Установка Postman

1. Перейдите на официальный сайт Postman и скачайте установщик для Windows, macOS или Linux.
2. Запустите загруженный исполняемый файл и следуйте инструкциям установщика.
3. При желании войдите в аккаунт Postman для синхронизации коллекций между устройствами.

Совет: в корпоративных средах уточните требования по прокси и политике безопасности перед установкой.

Интерфейс и создание запроса

Ниже — интерфейс Postman (версия, с которой сделаны скриншоты, могла измениться):

Чтобы создать запрос:

1. Нажмите кнопку New в левом верхнем углу.
2. Выберите Request или Basic HTTP Request в появившемся окне.

После выбора создайте новый запрос и заполните поля:

• Метод HTTP — GET, POST, PUT, PATCH, DELETE и другие.
• URL — адрес конечной точки (endpoint).
• Headers — заголовки запроса.
• Body — тело запроса для POST, PUT, PATCH.

Часто используемые HTTP-методы

• GET: получает данные.
• POST: создаёт новые ресурсы.
• PUT: полностью обновляет ресурс.
• PATCH: частично обновляет ресурс.
• DELETE: удаляет ресурс.

Пример: тест публичного API в Postman

В качестве примера используем публичный новостной API Newsdata.io. Структура запроса для получения новостей по стране:

https://newsdata.io/api/1/news?apikey=YOUR_API_KEY&country=us

Замените YOUR_API_KEY на ключ, который вы получите после регистрации на Newsdata.io. Вставьте обновлённый URL в поле URL в Postman и отправьте запрос. Пример ответа (обрезан для наглядности):

{
    "status": "success",
    "totalResults": 10173,
    "results": [
        {
            "title": "Apple could be the first to use TSMC's 3nm chip process for M2 Pro",
            "link": "https://appleinsider.com/articles/22/08/18/apple-could-be-the-first-to-use-tsmcs-3nm-chip-process-for-m2-pro?utm_medium=rss",
            "keywords": null,
            "creator": [
                "news@appleinsider.com (Mike Peterson)"
            ],
            "video_url": null,
            "description": "Apple's 2022 MacBook Pros may pack new M2 Pro and M2 Max chipsets made with TSMC's latest 3nm manufacturing process, according to a new report.M2TSMC, the world's largest semiconductor contract manufacturer, has been steadily building out its 3nm production processes. According to the Commercial Times, Apple could be the first customer to\u00a0get its hands on those chips. Read more...",
            "content": null,
            "pubDate": "2022-08-18 15:22:53",
            "image_url": null,
            "source_id": "appleinsider",
            "country": [
                "united states of america",
                "united kingdom",
                "india",
                "australia",
                "singapore",
                "canada"
            ],
            "category": [
                "technology"
            ],
            "language": "english"
        }
    ],
    "nextPage": 1
}

Postman отобразит массив новостных статей в виде JSON; интерфейс позволяет удобно просматривать, форматировать и копировать данные.

Мини-методология тестирования API в Postman

1. Подготовка: получите ключи, определите конечные точки и требования.
2. Базовые ручные тесты: отправьте GET/POST/PUT/PATCH/DELETE для проверки ответов.
3. Напишите позитивные и негативные тесты (валидные и невалидные payload).
4. Добавьте проверки (assertions) в Postman Tests таб: проверка статуса, схемы JSON, наличия полей.
5. Подключите коллекцию к CI/CD: запускайте коллекции в автоматических пайплайнах.
6. Мониторинг: настройте мониторинг для ключевых конечных точек.

Шаблон теста в Postman (пример кода в разделе Tests)

Простой тест на статус и наличие поля title в ответе:

pm.test("Status is 200", function () {
    pm.response.to.have.status(200);
});

pm.test("Response has title in first result", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.results[0]).to.have.property('title');
});

Заменяйте проверки под вашу схему данных.

Роли и чек-листы

Разделим ответственность по ролям для быстрой интеграции API:

• Разработчик:
  • Написал/документировал endpoint и payload
  • Подготовил mock-данные
  • Добавил базовые тесты в коллекцию Postman
• QA-инженер:
  • Проверил позитивные и негативные сценарии
  • Запустил тесты локально и в CI
  • Описал найденные баги с шагами воспроизведения
• Продакт/Менеджер:
  • Подтвердил соответствие бизнес-требованиям
  • Утвердил SLA и временные рамки тестирования

SOP: как быстро провести smoke-тест API перед релизом

1. Подготовка окружения: проверьте доступность тестовой среды.
2. Выполните health-check endpoint (/health или /_status).
3. Запустите набор smoke-тестов: авторизация, создание ресурса (POST), получение ресурса (GET), удаление (DELETE).
4. Проверяйте лог сервера и метрики ошибок.
5. В случае провала откатить изменения и запустить расследование.

Критерии приёмки

• Все smoke-тесты возвращают ожидаемые HTTP-коды и ответ в течение допустимого времени.
• Ключевые поля присутствуют и валидны.

Отладочный план и частые ошибки

1. 401/403 — проверьте токен/ключ API и заголовки Authorization.
2. 404 — проверьте URL и путь; убедитесь, что ресурс существует.
3. 422/400 — проверьте формат и обязательные поля в body.
4. 500 — проверьте логи сервера, сообщения об ошибках и трассировку.

Советы:

• Включите в Postman логирование ответа и заголовков.
• Используйте Postman Console для просмотра полной трассировки запроса.

Альтернативы и когда Postman может не подходить

• curl/HTTPie — хороши для простых одноразовых запросов в терминале.
• Интегрированные тесты в кодовой базе (например, с использованием библиотек для unit/integration tests) — лучше для непрерывной автоматизации.
• Специализированные API-симуляторы и контрактное тестирование (например, Pact) — когда важны контракты между сервисами.

Postman отлично подходит для ручной отладки, подготовки коллекций и первых этапов автоматизации, но для полностью автоматизированных end-to-end сценариев стоит комбинировать инструменты.

Сравнение: Postman vs curl vs встроенные тесты

• Удобство: Postman > curl
• Автоматизация в CI: встроенные тесты/скрипты > Postman (если не интегрировать с Newman)
• Простота встраивания в пайплайн: скрипты/инструменты CLI (Newman для Postman) помогают устранить разрыв.

Краткий глоссарий

• Endpoint — URL, по которому доступен ресурс.
• Payload — тело запроса или ответа.
• Mock — имитация поведения сервиса для тестов.
• Newman — CLI-версия Postman для интеграции в CI.

Примеры приемочных тестов

• Проверка успешного создания ресурса: POST возвращает 201 и корректный объект.
• Проверка валидации: отправка невалидного payload возвращает 400 и сообщение об ошибке.
• Проверка авторизации: без токена доступ запрещён (401).

Модель зрелости тестирования API (кратко)

1. Ручное тестирование в Postman.
2. Коллекции с тестами и мониторинг.
3. Интеграция в CI через Newman.
4. Контрактное тестирование и полное покрытие E2E.

Итог и рекомендации

Postman — удобный и мощный инструмент для работы с API на ранних и средних этапах разработки. Начните с ручных тестов и коллекций, затем добавляйте автоматизацию через Newman и CI. Всегда храните коллекции и спецификации под версионным контролем и документируйте ожидаемое поведение API.

Важно: для надёжности системы комбинируйте инструменты тестирования и не полагайтесь только на GUI-инструменты.

Примечание: если вам нужно шаблонное расположение коллекции для вашего проекта или playbook для CI, можно добавить пример конфигурации под ваш стек.