GUI-инструменты для тестирования API: от Postman до Hoppscotch

Артём Морозов
  • 1 ноября 2024
  • 111 просмотров
  • 0 комментариев

Для разработки и тестирования API существует множество инструментов, которые делают процесс работы с запросами удобнее и эффективнее. GUI-инструменты позволяют отправлять HTTP-запросы, отлаживать ответы, проверять API на различных стадиях разработки, и всё это через графический интерфейс. В этой статье рассмотрим популярные инструменты, их особенности и сильные стороны.

Postman

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

Основные возможности

  • Коллекции запросов: Postman позволяет создавать, сохранять и структурировать коллекции запросов, что особенно полезно при работе над большими проектами.
  • Автоматизация тестов: Встроенные возможности для автоматизации, включая поддержку тестов на JavaScript, позволяют проверять ответы API и упрощают процесс отладки.
  • Интеграции с CI/CD: Postman поддерживает интеграции с системами CI/CD, такими как Jenkins и GitHub, что упрощает управление API и тестирование в процессе разработки.
  • Поддержка окружений: Postman позволяет создавать и настраивать окружения (например, dev, staging, production), а также использовать переменные для разных сред.
  • Документирование API: В Postman можно создавать документацию для конечных точек (ЭП), описывая каждый запрос и параметры, что удобно для командной работы и обмена информацией.

Пример автотестирования

Postman позволяет писать автотесты с использованием JavaScript, что даёт возможность проверять статус ответа, данные и другие параметры. Рассмотрим пример запроса к API для получения информации о пользователе:

GET https://jsonplaceholder.typicode.com/users/1

Ниже представлен пример автотестов для этого запроса:

pm.test("Status code is 200", function() {
    pm.response.to.have.status(200);
});
pm.test("Response time is less than 500ms", function() {
    pm.expect(pm.response.responseTime).to.be.below(500);
});
pm.test("Response contains specific property", function() {
    var jsonData = pm.response.json();
    pm.expect(jsonData).to.have.property("username");
    pm.expect(jsonData.username).to.equal("Bret");
});

Этот тест проверяет, что API возвращает статус 200, ответ поступает менее чем за 500 мс и содержит свойство username со значением Bret. Такие проверки помогают выявлять ошибки в API на уровне ответа.

Интеграция с Jenkins

Интеграция Postman с Jenkins позволяет автоматически запускать тесты в рамках CI/CD. Для этого используется утилита Newman, с помощью которой можно выполнить коллекцию и отобразить результат в Jenkins:

1. Экспорт коллекции: Экспортируйте коллекцию из Postman в формат JSON (например, collection.json).

2. Запуск коллекции через Newman: Установите Newman и выполните команду:

    newman run collection.json -e environment.json --reporters cli,junit --reporter-junit-export results.xml

CLI использует файл окружения environment.json и сохраняет отчёт в формате results.xml.

3. Настройка Jenkins: Создайте Jenkins-пайплайн для автоматического запуска команды Newman и анализа отчёта results.xml. Это позволяет отслеживать стабильность API в процессе разработки.

Insomnia

Insomnia — простой и удобный инструмент для работы с API, который выделяется своей минималистичностью. Insomnia поддерживает REST и GraphQL, предлагает возможность работы с переменными и параметрами, а также позволяет визуально отображать ответы.

Основные возможности

  • Поддержка GraphQL: Insomnia легко справляется с запросами на GraphQL, позволяя создавать сложные запросы и визуализировать ответы.
  • Управление окружениями: Insomnia поддерживает настройку окружений и переменных, что упрощает работу с API в разных средах, как в Postman.
  • Плагины и расширения: Insomnia поддерживает плагины, что позволяет добавлять новые функции и адаптировать инструмент под нужды проекта.
  • Документирование API: Insomnia поддерживает базовое документирование запросов, однако функции ограничены в сравнении с Postman.
  • Автотестирование и интеграция с CI/CD: Insomnia позволяет выполнять автотесты через Insomnia CLI, но интеграция с CI/CD менее развита по сравнению с Postman, так как не предоставляет столь же гибких возможностей отчётности и настройки.

Сравнение интеграции с CI/CD в Insomnia и Postman

Insomnia CLI предоставляет ограниченные возможности для автоматизации и интеграции с CI/CD-системами по сравнению с Postman’s Newman. Вот основные различия:

  • Отчётность: Insomnia CLI выполняет тесты и выводит результаты только в текстовом формате или перенаправляет их в файл. В отличие от этого, Postman с Newman поддерживает несколько форматов отчётов, включая JUnit и HTML, что упрощает интеграцию с Jenkins и другими CI/CD-платформами для отслеживания результатов тестов.
  • Поддержка комплексных сценариев: В Postman через Newman можно организовать сложные сценарии тестирования с логическим контролем выполнения запросов, таких как циклы, условия и различные управляющие конструкции. Insomnia CLI позволяет запускать только простые запросы и тесты, без возможности гибкой настройки и создания сложных сценариев.

Пример автотестирования и интеграции с CI/CD для Insomnia

Создание автотестов

В Insomnia можно писать простые автотесты, используя JavaScript. Рассмотрим тестирование запроса к API:

// Пример запроса: GET https://jsonplaceholder.typicode.com/users/1

// Проверка статуса ответа
expect(response.status).to.equal(200);

// Проверка времени ответа
expect(response.time).to.be.below(500);

// Проверка наличия свойства в JSON
const json = JSON.parse(response.body);
expect(json).to.have.property("username");
expect(json.username).to.equal("Bret");

Эти тесты проверяют статус (200), время ответа (менее 500 мс) и наличие свойства username со значением Bret в ответе API.

Интеграция с CI/CD через Insomnia CLI

Для запуска тестов в CI/CD можно использовать Insomnia CLI, но стоит учитывать, что он предоставляет меньше возможностей для отчётов и автоматизации, чем Postman. Вот как это сделать:

  1. Установите Insomnia CLI: 
        npm install -g @insomnia/insomnia
  2. Экспортируйте коллекцию запросов из Insomnia в файл JSON (например, requests.json).
  3. Запустите тесты с Insomnia CLI: 
        insomnia run requests.json --environment environment.json
    CLI позволяет выполнить запросы и тесты, но не генерирует подробных отчётов в формате JUnit.
  4. Интеграция с Jenkins (пример): 
        insomnia run requests.json --environment environment.json > results.txt
    Этот пример записывает результаты выполнения в файл results.txt, который затем можно использовать для анализа тестов.

Insomnia подойдёт для разработчиков, которые ценят простоту и минималистичный интерфейс, а также тем, кому требуется поддержка GraphQL.

Swagger UI

Swagger UI — инструмент, предназначенный для документирования и тестирования API, созданных на основе спецификации OpenAPI. Этот инструмент часто используется вместе с Swagger Editor для визуализации API и выполнения тестовых запросов.

Основные возможности

  • Документация API: Swagger UI фокусируется на создании и визуализации документации API, основанной на спецификации OpenAPI, что делает его незаменимым для документирования API.
  • Тестирование: Инструмент позволяет выполнять запросы прямо из интерфейса документации, что удобно для быстрой проверки и отладки API.
  • Гибкость: Поддержка OpenAPI делает Swagger UI универсальным решением для тестирования и документирования API.
  • Поддержка окружений: Окружения не поддерживаются, так как инструмент предназначен для визуализации и тестирования, а не для управления тестовыми средами.
  • Автотестирование и интеграция с CI/CD: Swagger UI не поддерживает автотестирование или интеграцию с CI/CD, однако документацию можно использовать в связке с другими инструментами, такими как Swagger Codegen, для генерации клиентских библиотек.

Swagger UI — отличный выбор для тех, кому нужна визуальная документация API и возможность выполнять тестовые запросы прямо из документации.

Paw

Paw — это мощный инструмент для macOS, ориентированный на профессиональных разработчиков. Paw поддерживает REST и GraphQL и предлагает расширенные функции для работы с переменными и автоматизации запросов.

Основные возможности

  • Коллекции запросов: Paw поддерживает создание коллекций и сохранение запросов, что полезно для крупных проектов.
  • Поддержка окружений: Paw позволяет настраивать различные окружения для запросов, включая переменные, что облегчает работу с API в разных средах.
  • Документирование API: Paw предоставляет функции для документирования запросов, включая параметры и описание, что полезно для совместной работы.
  • Автотестирование и интеграция с CI/CD: Автотестирование и поддержка CI/CD в Paw реализованы с ограничениями. Интеграция с CI/CD возможна через экспорты коллекций и другие инструменты, но нет прямой интеграции, как в Postman, который предоставляет CLI-утилиту Newman, специально разработанную для запуска postman-коллекций на сервере или в CI/CD-системах. Newman позволяет запускать тесты с детализированными отчётами и гибко конфигурировать процессы без необходимости дополнительных инструментов или посредников. Он генерирует отчёты в нескольких форматах (например, JSON, JUnit, HTML). Благодаря этому результаты тестов можно легко интегрировать с системами отчётности CI/CD, такими как Jenkins, GitLab CI, CircleCI и другие, позволяя получать детализированные отчёты прямо в интерфейсе CI/CD.

Paw подойдет для профессиональных разработчиков, работающих на macOS, которым требуются мощные функции для управления и документирования API.

Hoppscotch

Hoppscotch (ранее Firecamp) — легковесный и быстрый API-клиент с открытым исходным кодом, который поддерживает REST, GraphQL и WebSocket.

Основные возможности

  • Поддержка GraphQL и WebSocket: Hoppscotch поддерживает создание и тестирование запросов для GraphQL и WebSocket.
  • Поддержка окружений: Hoppscotch поддерживает настройку окружений, что удобно для тестирования API в разных средах.
  • Документирование API: Hoppscotch позволяет добавлять описания к запросам, но функции для полноценного документирования ограничены.
  • Автотестирование и интеграция с CI/CD: Hoppscotch предлагает базовые функции автотестирования через CLI, что позволяет запускать тесты в командной строке и интегрировать их в CI/CD-системы.

Автотестирование и интеграция с CI/CD через Hoppscotch CLI

Hoppscotch предоставляет базовые функции для автотестирования через CLI, но в отличие от Postman и его утилиты Newman, возможности CLI в Hoppscotch ограничены по гибкости и отчетности. С помощью CLI можно запускать заранее созданные коллекции запросов и проверять базовые параметры ответа.

Пример настройки автотестов

Чтобы выполнить автотестирование с помощью Hoppscotch CLI, нужно сначала экспортировать коллекцию запросов из интерфейса Hoppscotch в формате JSON. Затем CLI позволяет запустить тесты и получить базовый результат выполнения.

hoppscotch-cli run collection.json --env environment.json

Команда hoppscotch-cli run запускает тесты из коллекции, где можно проверять такие параметры, как:

  • Статус ответа: Убедитесь, что ответ API соответствует ожидаемому статусу (например, 200).
  • Время отклика: Проверьте, что ответ возвращается в допустимые временные рамки.

Интеграция с CI/CD

CLI Hoppscotch предоставляет ограниченные возможности для интеграции с CI/CD. В отличие от Postman, Hoppscotch CLI не поддерживает создание детализированных отчётов в форматах, таких как JUnit или HTML. Однако базовый результат выполнения команды можно сохранить в файл и использовать его для анализа в CI/CD.

hoppscotch-cli run collection.json --env environment.json > results.txt

Этот метод позволяет интегрировать Hoppscotch в пайплайны CI/CD, например, Jenkins или GitLab CI. Однако из-за ограниченных возможностей отчётности и гибкости сценариев CLI Hoppscotch подходит только для базовых проверок API и не предоставляет такие расширенные функции, как логические проверки, циклы или условия, которые доступны в Postman.

Hoppscotch — хороший выбор для разработчиков, которым нужен лёгкий и быстрый API-клиент с минималистичным интерфейсом и поддержкой базового тестирования, но для сложных CI/CD-процессов могут потребоваться дополнительные инструменты.

Сравнение популярности

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

Postman является одним из самых популярных инструментов для тестирования API. Согласно данным StackShare, Postman используется в более чем 92,7 тыс. технологических стэков и имеет около 79,4 тыс. подписчиков. Его широкая функциональность и активное сообщество способствуют постоянному росту популярности.

Insomnia также пользуется значительной популярностью среди разработчиков. На StackShare Insomnia присутствует в 778 стэках и имеет 640 подписчиков. Его простота и поддержка различных протоколов привлекают многих пользователей.

Swagger UI широко используется для документирования API. Хотя точные цифры использования могут варьироваться, Swagger UI является стандартом де-факто для документирования RESTful API и интегрируется во многие проекты.

Paw ориентирован на пользователей macOS и имеет свою нишу среди разработчиков. На StackShare Paw используется в 228 стэках и имеет 276 подписчиков. Его интеграция с macOS и интуитивный интерфейс привлекают пользователей этой платформы.

Hoppscotch — относительно новый инструмент с открытым исходным кодом. Его популярность растет благодаря легковесности и доступности в веб-браузере. Точные данные о его использовании ограничены, но активное сообщество на GitHub и регулярные обновления свидетельствуют о растущем интересе.

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

Актуальность

Актуальность версий инструментов для тестирования API важна для обеспечения безопасности, стабильности и доступа к последним функциям. Рассмотрим текущие версии и частоту обновлений следующих инструментов: Postman, Insomnia, Swagger UI, Paw и Hoppscotch.

Postman

Postman регулярно обновляется, предоставляя новые функции и исправления. На момент написания статьи последняя версия — 10.20.0, выпущенная в октябре 2024 года. Частые обновления свидетельствуют о активной поддержке и развитии продукта.

Insomnia

Insomnia также активно развивается. Последняя версия — 2024.5.2, выпущенная в сентябре 2024 года. Регулярные обновления обеспечивают пользователям доступ к современным инструментам и улучшениям.

Swagger UI

Swagger UI является частью экосистемы OpenAPI и регулярно обновляется. Последняя версия — 4.15.5, выпущенная в октябре 2024 года. Обновления включают улучшения интерфейса и поддержку новых спецификаций OpenAPI.

Paw

Paw ориентирован на пользователей macOS и получает обновления с добавлением новых функций и улучшений. Последняя версия — 4.0.0, выпущенная в августе 2024 года. Хотя обновления выходят реже, они обычно содержат значительные улучшения.

Hoppscotch

Hoppscotch — проект с открытым исходным кодом, который активно развивается. Последняя версия — 2024.9.2, выпущенная в октябре 2024 года. Частые обновления свидетельствуют о динамичном развитии и активном сообществе.

В целом, все рассмотренные инструменты регулярно обновляются, что обеспечивает их актуальность и соответствие современным требованиям разработки API.

Заключение

Выбор инструмента для тестирования API зависит от конкретных потребностей и предпочтений разработчика. Postman предлагает обширный функционал и широкую интеграцию с CI/CD, что делает его отличным выбором для комплексных проектов. Insomnia привлекает своей простотой и поддержкой GraphQL, подходя для тех, кто ценит минималистичный интерфейс. Swagger UI является стандартом для документирования API, обеспечивая визуализацию и тестирование. Paw ориентирован на пользователей macOS, предлагая глубокую интеграцию с системой. Hoppscotch, будучи легковесным и доступным в браузере, подходит для быстрых проверок и тестирования.

Если вам интересно сравнение IDE для PHP-бэкенда, рекомендуем ознакомиться со статьей «Не только PhpStorm: сравнительный обзор IDE для PHP-бэкенда». Также, если вы ищете вакансии для Backend-разработчиков, посетите раздел вакансий.

Выбор подходящего инструмента и среды разработки способствует повышению эффективности и качества работы, поэтому важно учитывать все аспекты и особенности каждого решения.

Репетиция собеседования: как успешно пройти интервью в IT
    Оставьте отзыв
    (минимум 60 знаков)
    Оценка5/5
    Нужно авторизоваться