РазработкаSMS API

Как тестировать API, или Postman для чайников

20 дек 2023

Тестирование — обязательный этап разработки, который помогает проверить корректность работы приложения и выявить возможные ошибки. Существует множество различных инструментов для этой цели, но для начинающих программистов один из наиболее доступных — Postman.

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

Postman и его установка

Postman — это популярный инструмент для тестирования API, отправки запросов к серверу и создания документации. С его помощью разработчики могут эмулировать работу с API, отправляя различные запросы и анализируя ответы для проверки корректности реализации.

Например, вы сможете протестировать API наших продуктов. Они понадобятся в будущем при интеграции одного из решений МТС Exolve в вашу CRM-систему.

Особенности Postman

Postman предоставляет возможности для работы с запросами, коллекциями и окружениями, упрощая тестирование и проверку API-методов на работоспособность.

Утилита работает со следующими методами HTTP-запросов:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

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

Встроенный инструмент Collection Runner и отдельная утилита Newman позволяют запускать коллекции на выполнение. Например, используя Collection Runner, можно исполнить запросы из коллекции с определённым количеством итераций и последовательно. По окончании тестирования инструмент выдаёт код статуса запроса и выставляет пометку об успешности.

Внимание! Чтобы автоматизировать проверку, разработчики применяют скрипты на разных языках программирования (например, Java, JavaScript, Python, C#).

Окружение содержит различные наборы данных. Так разработчик отправляет запросы и коллекции на выполнение. Окружение состоит из пар «ключ-значение», где каждая пара представляет собой определённый параметр и его значение.

Ещё одна полезная особенность программы — параметризация. Она позволяет работать с переменными при исполнении запросов, что даёт возможность выполнить один и тот же запрос на множестве различных наборов данных.

Пример тестирования приложения в Postman с использованием параметров:

1. Протестируем эндпоинт https://exolve.ru/. Для этого в приложении Postman переходим по вкладке Workspace в верхнем левом углу и откроем нашу рабочую среду.

2. Создадим новый HTTP-запрос. Для этого кликнем по кнопке New и в появившемся модальном окне выберем протокол HTTP.

3. Вводим URL, по которому мы будем стучаться в этом случае, — https://exolve.ru/. По умолчанию будет выбран метод запроса GET, нажимаем кнопку Send.

4. Серверу понадобится какое-то время, чтобы ответить на этот запрос и вернуть содержимое в ответе. В нашем случае вместе с ответом от сервера придёт html-документ и статус ответа 200. Это означает, что обработка запроса и ответ сервера на него прошли успешно.

5. Мы сделали свой первый запрос на сервер с использованием Postman, но в действительности таких запросов может быть очень много, и постоянно вводить данные не совсем удобно. Поэтому в Postman есть инструмент для создания переменных Environment quick look для дальнейшего использования их в боевых условиях, давайте научимся им пользоваться. Находится он в верхнем правом углу, при клике откроется среда области видимости переменных. Создадим свою первую переменную в глобальной области видимости, нажав на кнопку Add.

6. В открывшемся окне нам необходимо задать имя переменной и её значение. В ячейке Variable пишем имя переменной url, в ячейке Initial value — значение переменной exolve.ru. Далее сохраняем данные, нажав на кнопку Save, и возвращаемся на главную страницу Postman, кликнув по вкладке в меню.

7. Теперь в адресе запроса мы можем использовать свою переменную, обернув её в двойные фигурные скобки {{url}}, в этом случае наш запрос будет выглядеть следующим образом: https://{{url}}. Протестируем наш запрос, нажав на Send, и получим всё тот же ответ с успешным статусом 200.

Почему junior-программисты выбирают Postman

Преимущества программы Postman:

  • Бесплатное распространение (есть и платная версия — базовый тариф от 14 $ в месяц на одного пользователя).
  • Универсальный и удобный интерфейс. Джуниор-разработчик разберётся в нём за несколько часов и перейдёт к тестированию приложений.
  • Поддержка разных API: GraphQL, REST, SOAP.
  • Postman обладает широкими возможностями масштабирования, предоставляя автоматизацию, интеграции, совместную работу и управление версиями API. Он адаптируется под различные задачи, учитывая его ограничения.
  • Кросс-платформенность. Инструмент доступен для трёх популярных операционных систем: Windows, Linux и macOS.
  • Подробная документация.

Postman не требует глубоких знаний языков программирования. Разработчик сможет интегрировать программу с иными решениями, такими как Swagger и RAML.

Как выполнить установку программы

С элементами и наборами в программе разобрались. Теперь давайте установим Postman на рабочий стол.

Инструкция:

1. Скачайте установочный файл для операционной системы Windows. Программа также доступна для установки на macOS и Linux. Для этого на странице загрузки выберите соответствующую вашей операционной системе версию.

2. Запустите скачанный исполняемый файл и дождитесь окончания установки.

3. Создайте профиль, зарегистрировав его на свой электронный ящик. Профиль понадобится, чтобы сохранять свои проекты.

4. Войдите в программу и настройте её соответственно своим требованиям.

Начните своё первое тестирование с помощью Postman.

Простой тест на Postman

  1. Запустите программу Postman.
  2. Создайте новый запрос. Для этого кликните по кнопке New в верхнем левом углу сервиса.
  3. Пропишите название будущего запроса.
  4. Выберите один из HTTP-методов (GET, POST, PUT, DELETE) в выпавшем меню рядом с адресом страницы клиента, которую будем тестировать.
  5. Пропишите URL вашего API в поле Enter request URL. Например, если вы хотите протестировать наш API для интеграции со своей CRM, URL может выглядеть как https://exolve.ru/products/sms-api/users.
  6. Если в запросе нужно включить заголовки, параметры, тело запроса и т. д., настройте их в соответствующих разделах Postman.
  7. Кликните на Send для исполнения запроса.
  8. Когда запрос будет исполнен, вы увидите ответ от сервера внизу окна Postman. Можно просматривать различные части ответа, такие как статус кода, заголовки, тело ответа и другие детали.
  9. Вероятно, вы захотите сохранить запросы в Postman для будущего использования и организовать их в коллекции.

Заключение

Мы рассказали о ключевых особенностях и преимуществах утилиты Postman. Попробовали протестировать своё первое приложение. Рекомендуем джунам более детально изучить инструмент и повысить уровень знаний до компетенций сеньоров.