Интерфейс прикладных программ (API) — это набор определений и протоколов, которые позволяют программам взаимодействовать друг с другом.
Термин REST означает передачу репрезентативного состояния. Это архитектурный стиль, состоящий из набора ограничений, используемых при создании веб-сервисов.
RESTful API — это API, который следует архитектуре REST. Обычно API-интерфейсы REST используют протокол HTTP для отправки и получения данных и ответов в формате JSON. Вы можете использовать стандартные методы HTTP для создания, просмотра, обновления или удаления ресурсов через API.
Для тестирования API RESTful и взаимодействия с ними вы можете использовать любую библиотеку или инструмент, который может выполнять HTTP-запросы.
Запросы API состоят из четырех разных частей:
- Конечная точка. Это URL-адрес, который клиент использует для связи с сервером.
- Метод HTTP. Он сообщает серверу, какое действие хочет выполнить клиент. Наиболее распространенные методы —
GET
POST
PUT
DELETE
иPATCH
- Заголовки. Используется для передачи дополнительной информации между сервером и клиентом, например авторизации.
- Тело. Данные отправлены на сервер.
В этой статье мы собираемся обсудить, как использовать curl
для взаимодействия с RESTful API. curl
— это утилита командной строки для передачи данных с или на удаленный сервер. Он установлен по умолчанию в macOS и большинстве дистрибутивов Linux.
Содержание
Параметры завивки
Синтаксис команды curl
следующий:
curl [options] [URL...]
Вот параметры, которые мы будем использовать при выполнении запросов:
-X
,--request
— HTTP-метод, который будет использоваться.-
-i
,--include
— включить заголовки ответа. -
-d
,--data
— данные для отправки. -
-H
,--header
— дополнительный заголовок для отправки.
HTTP GET
Метод GET запрашивает у сервера определенный ресурс.
GET — это метод по умолчанию при выполнении HTTP-запросов с помощью curl
. Вот пример выполнения запроса GET к API JSONPlaceholder для представления JSON всех сообщений:
curl https://jsonplaceholder.typicode.com/posts
Для фильтрации результатов используйте параметры запроса:
curl https://jsonplaceholder.typicode.com/posts?userId=1
HTTP POST
Метод POST используется для создания ресурса на сервере. Если ресурс существует, он перезаписывается.
Следующая команда выполняет запрос POST, используя данные, указанные с параметром -d
:
curl -X POST -d "userId=5&title=Hello World&body=Post body." https://jsonplaceholder.typicode.com/posts
Тип тела запроса указывается с помощью заголовка Content-Type
. По умолчанию, когда этот заголовок не задан, curl
использует Content-Type: application/x-www-form-urlencoded
.
Чтобы отправить данные в формате JSON, установите тип тела в application/json
:
curl -X POST -H "Content-Type: application/json"
-d '{"userId": 5, "title": "Hello World", "body": "Post body."}'
https://jsonplaceholder.typicode.com/posts
HTTP PUT
Метод PUT используется для обновления или замены ресурса на сервере. Он заменяет все данные указанного ресурса данными запроса.
curl -X PUT -d "userId=5&title=Hello World&body=Post body." https://jsonplaceholder.typicode.com/posts/5
HTTP-ПАТЧ
Метод PUT используется для частичного обновления ресурса на сервере.
curl -X PUT -d "title=Hello Universe" https://jsonplaceholder.typicode.com/posts/5
HTTP УДАЛИТЬ
Метод DELETE удаляет указанный ресурс с сервера.
curl -X DELETE https://jsonplaceholder.typicode.com/posts/5
Аутентификация
Если конечная точка API требует аутентификации, вам необходимо получить ключ доступа. В противном случае сервер API ответит ответным сообщением «Доступ запрещен» или «Неавторизован».
Процесс получения ключа доступа зависит от API, который вы используете. Получив токен доступа, вы можете отправить его в заголовке:
curl -X GET -H "Authorization: Bearer {ACCESS_TOKEN}" "https://api.server.io/posts"
Выводы
Мы показали вам, как использовать curl
для выполнения тестовых запросов API. Дополнительные сведения о curl
см. На странице документации по Curl .
Если у вас есть какие-либо вопросы или отзывы, не стесняйтесь оставлять комментарии.