Следуйте этому краткому руководству, чтобы начать использовать Postman. Вы узнаете, как установить приложение Postman, отправить API запрос, написать свой первый тест и сохранить запросы в коллекции. Вы также узнаете о работе в команде и о публичной сети API (Public API Network).
Postman – это приложение для использования, создания и тестирования API. Вы можете использовать десктопное приложение Postman для:
Отправки запросов с помощью клиента Postman API, включая HTTP, GraphQL и gRPC запросы
Проектирования, создания и документирования API
Тестирования функциональности и производительности вашего API
Организации работы в команде при разработке API.
Чтобы начать работу, загрузите и установите последнюю версию десктопного приложения Postman. Перейдите на страницу загрузки и выберите вариант для вашей операционной системы. Postman доступен в виде нативного десктопного приложения для macOS (Intel или Apple silicon), Windows (Intel 32-bit или 64-bit) и Linux (64-bit).
Отправка API-запроса
Встроенный API-клиент Postman позволяет создавать и отправлять API-запросы, включая HTTP, GraphQL и gRPC. С помощью Postman вы можете отправить запрос на необходимый эндпоинт (endpoint, в переводе с англ. — конечная точка), получить данные или протестировать функциональность API. Вам не нужно вводить команды в терминале или писать код. Когда вы создаете новый запрос и нажимаете Отправить (Send), API ответ появляется прямо в Postman.
Методы HTTP-запросов
API обеспечивает структурированный доступ одного приложения к возможностям другого приложения. Обычно такое взаимодействие происходит через интернет посредством сервера API. Клиентское приложение (например, мобильное приложение) отправляет запрос на сервер, и после обработки запроса сервер возвращает клиенту ответ.
Запрос включает в себя URL эндпоинта API и метод HTTP-запроса. Метод указывает на действие, которое вы хотите выполнить с помощью API. Вот некоторые из наиболее распространенных методов:
Нажмите + на рабочем столе Postman, чтобы открыть новую вкладку
Введите postman-echo.com/get в качестве эндпоинта запроса
Нажмите Отправить (Send).
В нижней панели Postman отображает данные ответа, отправленные с сервера:
В этом примере Postman выступает в роли клиентского приложения и взаимодействует с сервером API. Вот что произошло, когда вы нажали на кнопку Отправить:
Postman отправил GET запрос на Postman Echo API сервер, расположенный по адресу postman-echo.com
Сервер API получил запрос, обработал его и вернул ответ Postman
Postman получил ответ и отобразил его в панели ответов (Response).
Вы использовали Postman для отправки API-запроса и получили ответ от сервера API.
Создание API-тестов
API-тесты – это способ убедиться, что ваш API ведет себя так, как вы ожидаете. Например, вы можете написать тест для проверки обработки ошибок вашего API при отправке запроса с неполными данными или неверными параметрами. Вы можете написать тестовые сценарии для запросов на JavaScript и добавить их к отдельным запросам, коллекциям и папкам в коллекции. Postman включает в себя фрагменты кода, которые вы можете добавить и затем изменить в соответствии с логикой тестирования.
Чтобы написать API-тест, сделайте следующее:
Перейдите к запросу, который вы создали ранее
В запросе перейдите на вкладку Тесты (Tests)
В разделе сниппетов (snippet) справа выберите сниппет Код состояния: Код 200 (Status code: Code is 200). Это приведет к появлению следующего JavaScript кода: pm.test("Код состояния 200", function () { pm.response.to.have.status(200); });
Нажмите на кнопку Отправить (Send).
После выполнения запроса будет запущен тест. Перейдите в раздел ответа Результаты тестирования (Test Results), чтобы просмотреть результаты теста.
Чтобы узнать больше о написании тестов, перейдите по ссылке Написание тестов.
Вход в систему
Если вы используете десктопное приложение Postman и не вошли в систему, вы находитесь в легкой версии Postman API Client, которая представляет собой пространство, где вы можете создавать и отправлять запросы. Если вы хотите синхронизировать свою работу, объединять запросы в коллекции, сотрудничать с другими людьми или использовать другие функции, зарегистрируйте бесплатный аккаунт и войдите в Postman.
Чтобы создать аккаунт, выберите Создать аккаунт (Create Account) в правом верхнем углу. Вы можете зарегистрироваться, используя адрес электронной почты или учетную запись Google. Вам будет предложено предоставить некоторую информацию о себе, включая имя и должность, чтобы помочь настроить работу с Postman. Введите свои данные и выберите Продолжить (Continue).
Вы можете войти в десктопное приложение Postman, выбрав Sign In в правом верхнем углу. Вы также можете перейти на сайт Postman и выбрать Sign In в правом верхнем углу страницы. Это позволит вам выполнять многие задачи по разработке и тестированию API в веб-браузере. Имейте в виду, что некоторые функции не поддерживаются при использовании веб-приложения Postman, поэтому лучше использовать десктопную версию для полноценной работы с Postman.
Коллекции Postman (Collections) – это набор сохраненных запросов. Каждый запрос, отправленный вами в Postman, отображается во вкладке История (History) в боковой панели. В небольших масштабах повторное использование запросов через раздел истории очень удобно. По мере роста количества запросов, поиск определенного запроса в истории может занять много времени. Вместо того чтобы пролистывать раздел истории, вы можете сохранить все свои запросы в виде набора для более удобного доступа.
Чтобы создать новую коллекцию, вы можете начать с создания нового запроса, как было описано выше.
Чтобы создать коллекцию, сделайте следующее:
1. Войдите в десктопное приложение Postman
2. Выберите Новый > HTTP (New > HTTP)
3. Создайте запрос и нажмите Сохранить (Save)
4. Создайте новую коллекцию, нажав Новая коллекция (New Collection). Введите название коллекции, а затем выберите Создать (Create)
5. Нажмите Сохранить (Save), чтобы сохранить запрос в новой коллекции.
После того как вы сохраните запрос, ваша новая коллекция и запрос появятся в разделе Коллекции на боковой панели.
Вы также можете создать новую коллекцию во вкладке Обзор (Overview) вашего рабочего пространства. В разделе В этом рабочем пространстве (In this workspace) наведите курсор на вкладку Коллекции и нажмите на значок +.
Создание рабочего пространства
Рабочие пространства Postman (workspaces) позволяют организовать совместную работу над проектами API с вашей командой. В рамках каждого рабочего пространства вы можете делиться коллекциями, окружениями и другими элементами Postman.
Когда вы впервые откроете Postman, вы окажетесь в своем личном рабочем пространстве по умолчанию. Вы можете создавать дополнительные рабочие пространства для личного использования и для работы с коллегами. Чтобы создать больше рабочих пространств, вам нужно войти в свой аккаунт Postman.
Чтобы создать новое рабочее пространство, сделайте следующее:
1. Войдите в ваш аккаунт в Postman
2. Выберите Рабочие пространства (Workspaces) в левом верхнем углу. Выберите Создать рабочее пространство (Create Workspace) чтобы добавить новое рабочее пространство. Вы также можете найти существующие рабочие пространства с помощью строки поиска или выбрать одно из выпадающего списка.
3. Вы можете использовать шаблоны рабочего пространства чтобы помочь вам создать новое рабочее пространство. Выберите шаблон рабочего пространства, чтобы заполнить его полезной информацией и коллекциями, или выберите Blank workspace для создания пустого рабочего пространства. Затем нажмите кнопку далее (Next).
4. Введите Имя вашего нового рабочего пространства
5. Выберите, кто может получить доступ к рабочему пространству:
Рабочее пространство Personal. Если вы работаете в корпоративном тарифном плане (Enterprise), супер-администраторы (Super Admins) также будут иметь доступ ко всем личным рабочим пространствам, созданным в команде.
Рабочее пространство Private видно только вам и всем членам команды, которых вы туда пригласите (только в тарифных планах Professional и Enterprise).
Рабочее пространство Partner видно вашей команде и внешним партнерам (только для тарифных планов Postman Enterprise Ultimate).
Рабочее пространство Team видно всем членам вашей команды.
Рабочее пространство Public видно всем пользователям Postman.
6. Нажмите Создать (Create)
Postman переключится на ваше новое рабочее пространство, когда вы его создадите. Вы можете сразу же приступить к его редактированию и дополнению.
Вы можете перемещаться между рабочими пространствами в любое время, выбрав их из выпадающего списка Рабочие пространства (Workspaces) в левом верхнем углу.
Postman Public API Network – это крупнейшая сеть API, рабочих пространств, коллекций и потоков, созданных разработчиками по всей планете. Многие команды и компании, ответственные за создание передовых API и технологий, имеют публичные рабочие пространства, которые вы можете изучить. Здесь также публикуются популярные API сторонних разработчиков, а также примеры, которые можно использовать в качестве отправной точки при написании собственных API или коллекций.
Чтобы получить доступ к публичной сети API, посетите postman.com/explore или выберите API Network > View all public APIs.
Существует множество способов поиска API, рабочих пространств, команд, коллекций и потоков:
В поле Поиск в верхней части страницы по умолчанию выполняется поиск по всем командам, рабочим пространствам, коллекциям, API и потокам Postman. Вы также можете изменить область поиска на Public API Network чтобы ограничить поиск только сетью Public API Network.
Spotlight освещает последние интересные, полезные и заслуживающие внимания материалы в Public API Network, отобранные экспертами Postman.
Trending APIs показывает элементы, которые пользуются наибольшей популярностью в Public API Network, основываясь на количестве людей, просматривающих или создающих их форки.
Вы можете выбрать для просмотра Коллекции, Рабочие пространства и Потоки (Flows). Результаты коллекций и рабочих пространств можно сортировать по разделам Популярные (Featured), Новые (New), За неделю (Week) и За все время (All Time). Вы можете сортировать результаты Flows по Новым (New), Самым просматриваемым (Most Viewed) и Самым используемым (Most Forked).
Вы также можете фильтровать коллекции, используя категории, перечисленные на странице результатов.
Ознакомьтесь с некоторыми полезными коллекциями для начала изучения API, запросов и Postman:
Верифицированные команды Postman имеют значок верификации рядом с названием своей команды в Public API Network. Значок верификации означает, что Postman проверил личность команды как подлинной организации, которую она представляет, помогая вам обнаружить подлинные, полезные и надежные API.
Значок верификации также отображается рядом с именем проверенной команды в их профиле и публичных рабочих пространствах, и вы можете увидеть значок верификации в результатах поиска Postman.
Заключение
Теперь, когда вы отправили запрос, написали тест и можете сохранять запросы в коллекции, посмотрите, что еще можно делать в Postman:
Вы можете запускать коллекции вручную или запланировать регулярный запуск коллекций в облаке. Вы также можете автоматизировать запуск коллекций в CI/CD с помощью Postman CLI или Newman.
Postman Flows – это визуальный инструмент для создания приложений, управляемых API, для подхода API-first. Вы можете использовать Flows для создания цепочек запросов, обработки данных и создания реальных рабочих процессов в рабочем пространстве Postman.
Что касается API-first разработки, в Postman вы можете использовать API Builder.
Документация – важная часть любой коллекции или API. Вы можете добавить документацию чтобы пользователи могли понять, что делает ваша коллекция или API и как работает каждый запрос. По умолчанию документация является закрытой, но если вы создаете публичный API, вы можете опубликовать документацию, чтобы сделать ее общедоступной для всех, у кого есть веб-браузер.
Добавьте свой API в Public API Network чтобы поделиться своими API с 20М+ пользователями в крупнейшей в мире публичной сети API. Ваш API доступен для поиска в приложении Postman, если он размещен в Public API Network.
Пингбэк: Тест-кейсы для тестирования API
Пингбэк: Большой учебник по Postman