Руководство по методам GET, POST, PUT и DELETE при разработке API с помощью Postman
API можно сравнить с официантом в ресторане, который передает запросы клиентов/заказчиков повару на кухне, а затем возвращается к клиенту с обратной связью, либо с наличием, либо отсутствием заказанных блюд. Точно так же API выступает в роли связующего звена между пользователем программы и сервером.
Клиент/заказчик = пользователь
API = официант
Шеф-повар = сервер
Полная форма API — интерфейс прикладного программирования.
POSTMAN API
Postman — это API-платформа, используемая для создания и тестирования API. Она обеспечивает организованный сбор данных и тестирование API в графическом виде (GUI) с помощью таких HTTP-запросов, как GET, POST, PUT/PATCH, POST и DELETE.
GET — получение информации
POST — отправка информации
PUT/PATCH — обновление информации
DELETE — удаление информации
Введение в API с использованием postman:
В мире разработки API методы HTTP GET, POST, PUT и DELETE играют важнейшую роль при взаимодействии с ресурсами. Эти методы позволяют разработчикам выполнять различные операции с данными, такие как получение информации, создание новых записей, обновление существующих данных и удаление ресурсов. В этой статье мы рассмотрим значение этих методов и способы их эффективного использования с помощью популярного инструмента разработки API — Postman.
Создание учетной записи Postman
Первым шагом является создание учетной записи Postman. Если у вас уже есть учетная запись, то этот шаг можно пропустить.
Для создания новой учетной записи Postman необходимо выполнить следующие действия;
- Перейти на сайт https://identity.getpostman.com/signup
- Введите свой e-mail, имя пользователя и пароль и нажмите на кнопку «Создать учетную запись».
- После этого необходимо ввести свое имя и роль (например, студент / разработчик).
- Затем вам будет предложено пригласить свою команду. Пропустите этот процесс, нажав на кнопку «Продолжить без команды».
- Проверка электронной почты
- Готово, вы успешно создали учетную запись Postman.
Начало работы с API
Введите метку для идентификации проекта, например ‘APITut’, выберите ‘My Workspace’ из рабочей области и нажмите на Fork Collection для форка коллекции.
Перейдите по адресу https://bit.ly/postman-demo. Откроется коллекция в Postman. Выберите ‘Basics of API’ и нажмите на Fork, чтобы создать коллекцию.
Документация
Документация — это одна из наиболее важных частей, которую необходимо прочитать разработчику, чтобы понять, как использовать продукт/услугу. В некоторых программах она также называется ReadMe.
URL для запросов
В этом учебном пособии мы будем использовать тестовое API к примеру возьмем https://reqres.in в качестве тестового url, к которому мы будем выполнять различные HTTP-запросы.
Основы Postman:
1.GET-запрос в Postman:
Начнем работать с GET-запросом. Из коллекции разверните свой основной проект (Basic of API) и щелкните на GET Data. После этого введите https://reqres.in/api/users?page=2 в качестве url запроса, выберите метод GET и нажмите кнопку Send. Внизу появится секция Body, в которой в скобках отображается результат. Этот формат является форматом JSON, который известен как JavaScript Object Notation. В большинстве случаев все результаты работы API возвращаются в формате JSON.
2. POST-запрос в Postman:
Теперь попробуем выполнить POST-запрос. Щелкните на три точки в углу коллекции и выберите пункт Add Request.
В url запроса введите https://reqres.in/api/users и выберите метод POST. Теперь выберите Body -> raw и выберите JSON из выпадающего списка.
В его содержимом введите
{ «name»: «morpheus», «job»: «leader» }Измените приведенный выше код по своему усмотрению. Теперь нажмите кнопку отправить. Вы увидите следующий ответ
3.PUT-запрос в Postman:
Используя запрос PUT, мы можем изменять существующие данные. Создадим новый запрос, щелкнем на трех точках в углу коллекции и нажмем кнопку Add Request. Назовите его PUT (Update).
В url запроса введите https://reqres.in/api/users/2 и выберите метод PUT. Теперь выберите Body -> raw и выберите JSON из выпадающего списка. В его содержимом введите
Вы можете изменить отправляемые данные по своему усмотрению, изменитиь тег name или job, результат примера ниже
4. Запрос DELETE В Postman:
Используя запрос DELETE, мы можем удалить нашу шутку (полностью с указанием автора и источника). Попробуем это сделать.
Создайте новый запрос, щелкните на трех точках в углу коллекции и выберите Add Request. Назовите его DELETE. По ссылке https://reqres.in/api/users/1 делается запрос на удаление пользователя с id 1.
Итог:
Понимание методов GET, POST, PUT и DELETE очень важно для разработки надежных и эффективных API. Благодаря удобному интерфейсу и мощным возможностям Postman вы сможете легко работать с этими методами и оптимизировать процесс разработки API. Освоив эти методы HTTP и используя возможности Postman, вы сможете создавать высококачественные API, отвечающие потребностям ваших приложений и пользователей.
Помните, что разработка API — это итеративный процесс, и практика — это ключ к достижению мастерства. Итак, давайте окунемся в мир разработки API с использованием методов GET, POST, PUT и DELETE с помощью Postman!