Как отлаживать API с помощью Postman

Postman — это программа и набор инструментов, которые упрощают работу, разработку и отладку удаленных API-сервисов. Он предоставляет платформу для создания, управления и работы с запросами GET и POST.

Что такое почтальон?

Postman описывает себя как «Платформу для разработки API». На самом базовом уровне он предоставляет простой графический интерфейс для взаимодействия с удаленными API. По сути, это современный REST-клиент, разработанный для работы со сложными API.

Помимо того, что это отличный REST-клиент, он также содержит инструменты для управления коллекциями запросов. Используя эти коллекции и знание схемы API, он может запускать полностью автоматизированные тесты API, которые можно интегрировать в конвейеры CI/CD, чтобы гарантировать, что любые изменения кода не нарушат работу API в рабочей среде.

Использование почтальона

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

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

Вы можете изменить тип запроса в раскрывающемся списке на строке URL. Наиболее распространенными методами являются GET и POST, но полностью поддерживаются все команды HTTP.

На вкладке «Аутентификация» вам необходимо настроить ключи аутентификации для используемого вами API, если только он не является общедоступным. Postman поддерживает OAuth 1 и 2, а также большинство других типов токенов наряду с Basic Auth.

В разделе «Заголовки» вы можете установить заголовки сообщения, например Content-Type. Многие из них будут установлены автоматически, их можно просмотреть, нажав кнопку «Скрытые».

Для тела запроса вы можете указать данные формы с помощью пар ключ-значение, отправить двоичный пакет, запрос GraphQL или просто отправить необработанные JSON или текстовые данные. Редактор включает в себя встроенный редактор JSON и валидатор.

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

После того, как вы подготовили свой запрос, вы можете протестировать его с помощью кнопки «Отправить». Вы должны получить ответ от удаленного сервера, который вы можете просмотреть в Pretty-print, предварительном просмотре HTML или просто в необработанном виде. В строке состояния над

Вы также можете изменить раскрывающийся список с «Тело» на «Заголовок», чтобы просмотреть заголовки, возвращенные API.

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

Если вы хотите вернуться к нему или сохранить тест, вы можете сохранить его в «Коллекцию». Затем вы можете использовать Collection Runner из верхней строки меню для запуска всех запросов и тестов в коллекции, которую можно использовать для модульного тестирования всех конечных точек API.