Вы устали от необходимости создавать клиентскую часть для тестирования своих API? Позвольте представить вам Почтальона! Postman — это платформа для совместной разработки API. Это позволяет улучшить и ускорить процесс создания и разработки API. В этом руководстве мы будем использовать JavaScript, mySQL и NodeJS (экспресс для сервера), чтобы продемонстрировать мощь Postman как инструмента разработки. Мы рассмотрим пошаговый процесс, начиная с установки Postman и заканчивая тестированием ваших API с помощью Postman.
Как установить Postman
- Mac
- Чтобы установить Postman, вам сначала необходимо загрузить программное обеспечение по этой ссылке:
https://www.postman.com/downloads/ - Разархивируйте Postman-osx-X.XX.X.zip, затем запустите Postman. Переместите Postman в папку Applications.
- Вы можете войти в приложение или пропустить процесс входа (выберите светлый текст внизу)
- Windows
- Чтобы установить Postman, вам сначала необходимо загрузить программное обеспечение по этой ссылке:
https://www.postman.com/downloads/ - После загрузки запустите файл setup.exe
- Вы можете войти в приложение или пропустить процесс входа (выберите светлый текст внизу).
Откройте для себя Почтальон
Теперь, когда у нас установлен Postman, мы приступим к изучению основных функций Postman.
- Типы запросов
В зависимости от вашего API, который вы создали, вы можете выбрать, какой тип запроса вы тестируете. Выбрав стрелку раскрывающегося списка, вы можете выбрать тип запроса. Там есть несколько вариантов, но в этом уроке мы рассмотрим наиболее часто используемые: GET, POST, PUT/PATCH и DELETE.
- URL и отправить
Прямо рядом с типом запроса есть ввод URL. Здесь вы предоставите URL-адрес вашего приложения, сервера и конечных точек, необходимых для вашего запроса API. Если вы знаете, на какой тип запроса вы ориентируетесь, вы можете ввести любой URL-адрес и получить результат. Например, вы можете сделать запрос GET и ввести «google.com» в URL-адрес, и вы получите какой-то результат. Это может не иметь большого смысла, но дает представление о том, как работает Postman.
- Тело и параметры
Для запросов API, которые требуют каких-либо входных данных или данных от клиента, здесь вступают в игру Params и Body. В зависимости от цели запросов API вы можете выбирать между Params и Body. При использовании Params каждый раз, когда вы добавляете ключ и значение, они добавляются к используемому вами URL-адресу. С другой стороны, тело не будет раскрывать ваш ключ и значение в вашем URL-адресе.
Базовый код CRUD итестирование конечных точек
Мы будем использовать этот пример кода для тестирования некоторых API с помощью Postman. Имейте в виду, что Express использовался для запуска сервера этого приложения для связи с Postman. Не стесняйтесь клонировать мой репо. Обязательно установите все зависимости.
Репозиторий GitHub: https://github.com/mnallas/Todo-App
В этом руководстве мы будем тестировать функциональность CRUD, которая будет охватывать следующие типы запросов. Я покажу несколько примеров, которые мы можем протестировать и проанализировать. Мы запускаем сервер локально и устанавливаем URL-адрес:
http://localhost:${PORT}
Вы можете установить ПОРТ на любой удобный для вас. В этом руководстве мы будем использовать 3000 в качестве ПОРТА.
ПОЛУЧИТЬ код запроса
- В Postman установите тип запроса на GET.
- Укажите URL-адрес + конечную точку, которую вы создали для своего запроса, в поле URL-адреса.
Поскольку код ничего не требует, вы можете оставить поля body/params пустыми. Нажмите «Отправить», чтобы получить результат.
Результат:
Код запроса POST
- В Postman установите тип запроса на POST.
- Укажите URL-адрес + конечную точку, которую вы создали для своего запроса, в поле URL-адреса.
3. Поскольку это запрос POST, нам нужно указать ключ и значение в Body. Для этого кода требуется значение todo. Выберите Отправить для получения результата.
Результат:
Код запроса PUT/PATCH
- В Postman установите тип запроса на PATCH.
- Укажите URL-адрес + конечную точку, которую вы создали для своего запроса, в поле URL-адреса.
3. Поскольку это запрос PATCH, нам нужно будет указать ключ и значение в Body, которые вы хотели бы изменить. Для этого кода требуется значение для ключей: todoText, todoId (целевой объект) и todoCompleted. Выберите Отправить для получения результата.
Результат:
УДАЛИТЬ код запроса
- В Postman установите тип запроса на DELETE.
- Укажите URL-адрес + конечную точку, которую вы создали для своего запроса, в поле URL-адреса.
- Поскольку это запрос DELETE, нам нужно будет предоставить параметр для идентификатора, который будет нацелен на объект, который мы хотим удалить. Для этого примера мы удалим объект с идентификатором =1. Выберите Отправить для получения результата.
Результат:
Теперь, когда вы узнали об этом, вы сэкономите огромное количество времени на тестировании своего кода, прежде чем приступить к работе с внешним интерфейсом вашего веб-сайта. Postman может предложить и другие интересные функции. Оставайтесь любопытными и начинайте программировать!