Как отправить запрос в ВЕБ-API REST

Тип запроса

Тест REST Web API поддерживает различные методы HTTP, которые могут быть использованы в соответствии с целями тестирования. Выбор запроса GET позволит просто получить данные из веб-API. Хотя параметры запроса могут быть включены в URL-адрес, рекомендуется использовать выделенные методы для подталкивая полезную нагрузку к API.

Для отправки любой пользовательской информации, изменения данных или запуска любого потока или события используйте такие типы запросов, как POST, PUT или PATCH. В этом случае, чтобы указать тело запроса, перейдите в раздел Почтовые данные.

Если вы установите тип запроса на POST, PUT или PATCH, но не укажете параметры запроса в разделе Почтовые данные, тип запроса будет изменен обратно в GET после сохранения задачи.

аутентификация

Если API требует проверки подлинности, предоставьте учетные данные в разделе Базовая аутентификация. Если используется метод проверки подлинности на основе токенов, следуйте рекомендациям API на основе OAuth 2.0 и настройте параметры проверки подлинности аналогичным образом.

Почтовые данные

В этом разделе вы можете легко предоставить любые объекты запроса, такие как JSON.

Чтобы указать тело запроса, просто вставьте или введите содержимое JSON в поле. Система автоматически анализирует код, и вам будет предложено выбрать заголовок типа содержимого на основе типа тела запроса. Кроме того, при необходимости можно предоставить заголовок пользовательского типа содержимого.

После того, как указано, тип содержимого будет автоматически добавлен в раздел Headers.

Создание коллекции запросов

Вы можете отправить столько запросов в тесте, сколько захотите. Обратите внимание, что все запросы должны быть добавлены к тесту в порядке, который они должны быть выполнены.

Для настройки многопросчатого теста:

  1. Во-первых, создайте и сохраните новый тест API Rest Web.
  2. Чтобы настроить последовательность запросов в тесте, в списке тестов, из меню действий

    теста, выберите Add Target.
  3. Настройка настроек запроса и сохранение изменений. Запросы будут указаны на боковой панели на экране редактирования устройства в том порядке, в каком они будут выполнены. Для доступа к параметрам запроса выберите соответствующий элемент на боковой панели.
  4. Чтобы добавить следующий запрос из интерфейса редактирования устройства, нажмите кнопку “плюс” на боковой панели.

Чтобы узнать больше информации о настройке и мониторинге многоцелевых устройств, см.

Проверка результатов

Как правило, недостаточно просто позвонить в API, чтобы убедиться, что ответ API содержит данные, которые должны были получить. Чтобы проверить ответ API, достаточно найти некоторые ключевые слова, которые точно совпадают в ответе. Зная содержание ответа API, вы можете предоставить ключевые слова в разделе Проверка содержимого. Подробности смотрите в статье «Ключевое слово».

Use Cases

Рассмотрим в качестве примера api REST по электронной почте. Для мониторинга службы нам необходимо отправить запрос POST в соответствующую конечную точку API вместе с данными электронной почты в органе запроса. Для этого мы должны предоставить URL-адрес конечной точки и выбрать тип запроса POST.

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

В разделе Почтовые данные мы указать массив JSON с данными электронной почты и выбрать тип заголовка, чтобы подтолкнуть полезную нагрузку к конечной точке API.

Следующим шагом является указать ключевое слово для поиска в ответе API для его проверки.

  • Мониторинг API REST

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

    Допустим, вы создали RESTful API для вашего веб-сервиса, и необходимо контролировать, что все функции API работают должным образом и доступны 24/7. Но почему мы должны протестировать WEB API, не проще ли протестировать пользовательский интерфейс на проблемы? Давайте обсудим наиболее распространенные преимущества тестирования и мониторинга API.

    Первое преимущество тестирования REST API заключается в том, что оно помогает определить конкретный источник проблемы. Проверяя API, вы можете найти, какая конкретная функция выполняется с ошибками.

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

    Хотя вы можете протестировать все функции API вручную, это сложный и трудоемкий процесс. Кроме того, каждый раз, когда вы вносяете изменения или добавляете новые функции в API, тесты должны выполняться снова, чтобы убедиться, что обновления не повлияли на функциональность API. Автоматизированный мониторинг REST API позволяет избежать недостатков ручного тестирования и может вывести режим мониторинга API на новый уровень.

    Мониторинг REST API с помощью Dotcom-Monitor

    Dotcom-Monitor предлагает два варианта автоматического мониторинга производительности API:

    • Устройство мониторинга API REST Web.
    • Устройство мониторинга коллекции Почтальона.

    Для настройки теста мониторинга RESTful API с нуля рекомендуется использовать наше устройство мониторинга REST Web API. Этот тип устройства мониторинга позволяет настроить простой запрос HTTP в конечную точку API с базовой аутентификацией и параметрами POST.

    В случае, если вы уже использовали Postman для запуска тестов ваших услуг RESTful API, рекомендуется импортировать вашу коллекцию Почтальона в Dotcom-Monitor. После того, как коллекция запросов Postman была импортирована в систему, вы можете настроить устройство мониторинга Postman Collection для автоматизации мониторинга ваших служб API.

    Хотя устройство REST Web API поддерживает выполнение нескольких запросов, в некоторых случаях настроить его может быть сложно. В свою очередь, если вы знакомы с инструментом, Почтальон отлично подходит для настройки параметризированы HTTP запросы и тесты утверждения для мониторинга REST Web API.

    Таким образом, если вы хотите создать тест со сложной последовательностью вызовов API или когда требуется проверка подлинности, помимо базовой аутентификации, используйте Postman для создания коллекции вызовов API. Затем просто импортировать его на устройство Dotcom-Monitor Postman Collection и настроить мониторинг, как описано в Postman Monitoring (Задачи сбора) с Dotcom-Monitor API. Dotcom-Monitor будет выполнять вызовы API с заданной частотой (до 1 мин), генерировать отчеты и отправлять уведомления об ошибках мониторинга на предоставленный адрес.

    Не забудьте проверить наш полный набор инструментов мониторинга API на Dotcom-Monitor, чтобы помочь обеспечить надежность веб-приложений и услуг!