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

Эштон Хсу

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

Дилемма бэкэнд-разработки

Во время разработки продукта нам часто приходится создавать конечные точки внутреннего API, но у нас нет простого способа протестировать работу. Например, что, если новейшие функции внешнего интерфейса все еще разрабатываются, но разработчику серверной части нужен способ протестировать свои новые конечные точки API?
Один из способов — отправить запросы cURL в терминале, что потребует мучительного разбора стены текста. внести правки.

Отслеживание и изменение HTTP-запросов может быстро стать громоздким. Postman решает эти проблемы, организуя HTTP-запросы и управляя ими. Я расскажу о нескольких способах, которыми это может помочь.

Использование Postman для аутентификации пользователя

Конечная точка, которую я разрабатываю, требует веб-маркера JSON (JWT) для аутентификации, прежде чем я смогу выполнить свой новый код. Я буду использовать Postman для аутентификации пользователя, хранения и отправки JWT в будущих запросах API.

Среды и переменные

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

Чтобы настроить новую локальную среду и переменные:

  1. Нажмите на серый значок шестеренки в правом верхнем углу.
  2. Нажмите «Добавить»
  3. Назовите свою среду «локальной»
  4. Добавьте новую переменную с именем «email» и установите значение [email protected].
  5. Добавьте еще одну переменную с именем «пароль» и установите значение password123.
  6. Добавьте еще одну переменную с именем host и установите значение http://localhost:3000.
  7. Сохраните среду, нажав «Добавить».

Сделать запрос на вход

Вы можете использовать новые переменные среды, заключив имена переменных в двойные фигурные скобки в своих запросах. Собираем вместе:

  • Отправьте новый запрос POST по URL-адресу {{host}}/api/login.
  • На вкладке body вставьте эту полезную нагрузку json, которая включает ваш адрес электронной почты + пароль
{
    "email":"{{email}}",
    "password":"{{password}}",
}
  • Нажатие «Отправить» должно вернуть ответ 200 с JWT в теле.
{
    "jwt":"my_jwt_token"
}

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

Сценарии

Postman содержит среду выполнения JavaScript, которая позволяет запускать JavaScript до и после запросов. Скрипты позволяют изменять полезные данные, анализировать и сохранять переменные из ответов и многое другое. Порядок выполнения Postman для скриптов выглядит так:

Я буду подключаться к сценарию почтового запроса, чтобы сохранить свой JWT как переменную. Под запросом на вход нажмите «Тесты» и вставьте фрагмент

var response  = JSON.parse(responseBody);
// assign environment variable
pm.environment.set("JWT", response.jwt);

Поскольку я сохранил свой JWT как переменную среды, я могу повторно использовать свой JWT во всех своих запросах, требующих аутентификации. Мой JWT требуется в моем заголовке «Авторизация» для запросов, которые я могу легко установить.

На этом этапе я могу делать аутентифицированные HTTP-запросы к новым маршрутам API, которые я разрабатываю.

Последние мысли

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

Дальнейшее чтение

Первоначально опубликовано на https://floqast.com 17 августа 2020 г.