Тесты Пообщаться с GPT Протестировать код
Программирование Аналитика Дизайн Маркетинг Управление проектами
10 Окт 2023
9 мин
46682

Postman: как пользоваться программой для тестирования API

Пройдите тест, узнайте какой профессии подходите

Бесплатный сервис, который пишет тесты и поддерживает разные типы API.

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

В онлайн-университете Skypro есть программа «Инженер по тестированию» — на ней ученики осваивают профессию с нуля за двенадцать месяцев, делают четыре проекта для портфолио. Преподаватели — руководители отделов тестирования и старшие разработчики в ВТБ, Skyeng и других крупных компаниях. 95% выпускников выходят на работу в течение четырех месяцев: в этом помогает центр карьеры.

Что такое Postman

Postman — это ведущая платформа, где можно разрабатывать, тестировать, документировать и мониторить API (Application Programming Interfaces). Изначально Postman создавали как расширение для браузера Chrome, чтобы упростить работу с HTTP-запросами. Сейчас Postman эволюционировал в мощное кросс-платформенное приложение (для Windows, macOS, Linux) и облачный сервис. Сегодня это стандарт для миллионов разработчиков, тестировщиков и инженеров по всему миру.

Проще говоря, Postman — это «швейцарский нож» для работы с API.

Что там можно делать:

  • создавать, настраивать и отправлять HTTP-запросы (GET, POST, PUT, DELETE и др.) к любым API, просматривать ответы в удобном формате (например, JSON, XML, HTML);
  • организовывать запросы в коллекции, использовать переменные для разных сред (разработка, тестирование, продакшен), писать автоматизированные тесты на JavaScript;
  • запускать коллекции запросов и тестов как единые сценарии — скрипты, интегрировать их в процессы CI/CD (непрерывной интеграции и доставки);
  • автоматически создавать красивую, интерактивную и актуальную документацию;
  • настраивать периодический запуск коллекций, чтобы проверять работоспособность и производительность API;
  • создавать виртуальные серверы API на основе коллекций, чтобы клиенты могли начать разработку, даже если бэкенд еще не готов;
  • совместно с командой работать над API.

Преимущества

Ключевые плюсы Postman:

  • удобство и наглядность: графический интерфейс делает сложные операции с API простыми и понятными;
  • кросс-платформенность: работает на всех основных ОС и как веб-приложение;
  • автоматизация: мощные возможности для скриптов и тестирования экономят время;
  • коллаборация: встроенные инструменты для командной работы над API;
  • всё в одном месте: полный цикл работы с API — от разработки и тестирования до документирования и мониторинга.

Postman — незаменимый инструмент для backend-разработчиков, frontend-разработчиков, тестировщиков (QA), технических писателей, архитекторов и DevOps.

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

Установить Postman просто — займет всего несколько минут. Вот пошаговая инструкция:

  1. Перейдите на сайт Postman: https://www.postman.com/downloads/. Браузер автоматически определит вашу операционную систему (Windows, macOS, Linux).
  2. Нажмите на кнопку Download for Windows (если у вас Windows), Download for Mac (если macOS) или Download for Linux (если Linux). Начнется загрузка установочного файла.
  3. Найдите скачанный файл (обычно он лежит в папке «Загрузки») и запустите его двойным кликом.
  4. Для Windows: файл будет называться примерно Postman-win64-XX.X.X-Setup.exe. Следуйте инструкциям установщика (просто нажимайте Next или Install).
  5. Для macOS: файл будет называться Postman-osx-XX.X.X.zip. Распакуйте скачанный архив. Появится значок приложения Postman. Перетащите его в папку Программы (Applications).
  6. Для Linux: файл будет .tar.gz. Распакуйте его в удобное место (например, tar -xzvf Postman-linux-XX.X.X.tar.gz в терминале). Еще можно установить через Snap Store командой sudo snap install postman.
  7. После установки на Windows Postman обычно запускается автоматически. Или найдите его в меню Пуск.
  8. Для macOS откройте папку «Программы» и запустите Postman. При первом запуске система может спросить, доверяете ли вы приложению, — подтвердите.
  9. Для Linux: зайдите в распакованную папку и запустите файл Postman (или ./Postman в терминале). Можно создать ярлык на рабочем столе.
  10. При первом запуске Postman предложит войти в аккаунт (Sign In) или создать бесплатный аккаунт (Sign Up for Free). Он нужен, чтобы синхронизировать данные и использовать все облачные функции. Можно выбрать Skip and go to the app, но тогда функционал будет ограничен.

Как пользоваться Postman

В статье будем использовать бесплатный сервис {JSON} Placeholder. Он дает бесплатный API с фейковыми данными, чтобы тестировать приложения.

Интерфейс

На главном окне четыре рабочих блока:

  1. основное меню;
  2. сайдбар;
  3. выбор типа запроса и сам URL;
  4. рабочая область.
    Postman интерфейс

Как выполнить запрос

В Postman запросы — основная рабочая единица. Нажмите «+» и выберите тип запроса. Например: «основной — GET». Потом укажите URL в адресной строке и щелкните Send.

Выполняем запрос

Выполняем запрос

Как передавать параметры

Используйте онлайн-сервис postman-echo, чтобы проверить передачу параметров.

GET-параметры

Нажмите «+», чтобы создать новый запрос → в поле запроса пропишите https://postman-echo.com/get → метод GET.

GET-параметры указывают в разделе Params. Откройте этот раздел под строкой запроса и наберите название параметра в графе Key (например, Foo), а его значение — в Value (например, Bar). Теперь кликните Send и смотрите результат.

Передаем GET-параметры

Передаем GET-параметры

Параметры формы

Параметры формы передаются через POST-запросы. Нажмите «+» → POST → в адресную строку добавьте https://postman-echo.com/post. В теле запроса (Body) выберите вкладку form-data и заполните необходимые поля → отправьте (Send).

Передача файла

Для этого в form-data поменяйте тип параметра с Text на File. Полученный ответ будет храниться в разделе Files.

Заголовки

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

code

Передаем заголовок

Авторизация

Есть много методов и способов, чтобы зарегистрироваться и авторизоваться на сервере. Рассмотрим базовую схему авторизации. При такой схеме логин и пароль передаются в заголовке «Authorization» в незашифрованном виде. С помощью Postman можно убедиться, что протокол работает правильно и, главное, безопасно.

Для примера возьмем URL-адрес https://postman-echo.com/basic-auth.

Поменяйте метод на GET. Откройте вкладку Authorization → Нажмите Type → Basic Auth. Введите имя пользователя — postman, пароль — password → Send. Если протокол авторизации работает корректно, сервер выдаст: authenticated: true.

Basic Auth

Проверяем авторизацию Basic Auth

История запросов

Если некоторые запросы используете чаще других, необязательно раз за разом вводить новые данные. Можно воспользоваться списком в разделе History. Он хранит предыдущие запросы.

Коллекции запросов

Есть специальные архивы, чтобы хранить запросы, — коллекции. Здесь можно структурировать, организовывать запросы, раскладывать по папкам, чтобы их было проще найти. Это полезно для средних и больших проектов.

Как создать коллекцию: в разделе Collection нажмите «+» → дайте ей название → заполните запросами (Add request).

Как тестировать запросы

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

Запрос состоит из URL-адреса и HTTP-метода. Последний указывает тип действия, который запрашивается у API. Вот наиболее распространенные методы:

  • GET — получить данные;
  • POST — добавить новые данные;
  • PUT — заменить данные, которые имеются;
  • PATCH — обновить некоторые поля данных;
  • DELETE — удалить данные.

Например, если вы тестируете API онлайн-планировщика дел, можете использовать: GET-метод, чтобы получить текущий список задач; POS, чтобы создать новую задачу; PUT или PATCH, чтобы редактировать существующую; DELETE, чтобы удалить задачу.

Правильно формулировать запросы с помощью Postman и других инструментов и создавать нагрузочные тесты для API можно научиться на курсе «Инженер по тестированию» в Skypro. За девять месяцев освоите все основные инструменты тестировщика и сможете устроиться на престижную и высокооплачиваемую работу.

GET-запросы

Для примера возьмем API:

Нажмите «+» → Выберите GET-запрос → Задайте URL-адрес https://jsonplaceholder.typicode.com/users → Send.

users

Если запрос выполнен корректно, в нижней панели появится надпись: «Status: 200 ОК».

POST-запросы

POST-запросы отправляют новую информацию. Например, данные о пользователе:

Кликните «+» → Выберите POST-запрос → Задайте URL-адрес https://jsonplaceholder.typicode.com/users→ Перейдите в раздел Body → Выберите Raw > JSON → Введите данные пользователя → Send.

Если запрос выполнен корректно, вы увидите статус «201 Created».

Создание переменных окружения

Переменные окружения чаще используют, чтобы хранить части URL-адреса. Для работы с ними используют простой синтаксис. После того как создадите переменную, к ней можно обратиться через двойные фигурные скобки, например {{param}}. При этом появится автозаполнение: программа покажет вам все доступные переменные с таким именем.

Как создать переменную:

  1. Слева выберите раздел Environments.
  2. Для глобальной переменной — Globals. Если нужны локальные переменные, нажмите «+» сверху, чтобы создать свое окружение.
  3. В графе VARIABLE введите имя переменной, в INITIAL VALUE — ее значение. Для примера создадим глобальную переменную, назовем json, а в качестве значения зададим базовый URL — https://jsonplaceholder.typicode.com.
  4. Сохраните (Save).

Для переменной в адресной строке откройте две фигурные скобки и наберите json. Вы увидите список доступных переменных, включая ту, которую мы только что создали: {{json}}/posts — для списка постов, {{json}}/users — чтобы получить список пользователей.

Создание переменной

Создание переменной

Подробнее о доступных методах и конечных точках для этого API смотрите на официальном сайте.

Как создать тесты в Postman

В Postman тесты нужны, чтобы определить ошибки в работе API и переписать неправильные фрагменты кода. Чтобы запустить тест, откройте запрос и перейдите в раздел Tests.

Введите такой код:

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

Нажмите Send, чтобы Postman запустил тестовый сценарий. Выходные данные появятся на вкладке Tests Results. Если всё выполнено верно, будет написано:
1 PASS: «Status code: Code is 200».

Как запускать коллекции тестов

Посмотрим основные сценарии.

В Collection Runner

  1. В разделе Collections найдите кнопку Run.
  2. В новом окне выберите окружение и задержку. Если тест будет выполняться без задержки, его результат может быть ошибочным, поэтому лучше указать хотя бы минимальное значение.
  3. Установите значение iterations равным десяти и нажмите Send.
  4. Откроется отчет, который можно экспортировать (Export Results).

В Newman
Это приложение использует командную строку вместо графического интерфейса. С его помощью можно запускать тесты с консоли.

  1. Установите NodeJS по ссылке: http://nodejs.org/download/.
  2. Введите в командной строке:
    1 npm install -g newman.
  3. В разделе Collections нажмите значок «⋮».
  4. Выберите Export → Export Collection as Collection 2.1 (Recommended) → Export.
  5. Выберите папку для экспорта и нажмите Save.
  6. Теперь нужно экспортировать окружение, которое используется в этой коллекции. Выше мы использовали глобальное окружение. Зайдите в Environments → Globals → выберите Export (рядом с Save). Затем выберите нужную папку и кликните Save.
  7. В терминале откройте папку, куда сохранили коллекцию с переменными окружения.
  8. Запустите коллекцию командой:
    1 newman run [название файла коллекции].json -e
    [название файла с переменными].json

Инженер по тестированию — важный специалист в сфере IT: без его внимания не обходится ни один программный продукт. В онлайн-университете Skypro обучиться этой профессии можно с нуля за двенадцать месяцев. За это время вы научитесь проводить ручное и автоматическое тестирование, работать с системами баг-трекинга и Git. В конце учебы получите диплом о профессиональной переподготовке.

Главное о Postman

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

Добавить комментарий