Перейти к содержанию

Как работает REST API? Пошагово от запроса до ответа

В REST API клиент отправляет HTTP-запрос к URL, а сервер обрабатывает его и обычно возвращает ответ в формате JSON. Статья описывает этот цикл, HTTP-методы, правило отсутствия состояния и риски в аутентификации.

Nurullah Okatan · Автор контента
· Обновлено: · 2 мин чтения

Как работает REST API? Пошагово от запроса до ответа

REST API передаёт данные между двумя программами через обмен запросами и ответами по HTTP: клиент отправляет запрос к адресу ресурса определённым методом, сервер обрабатывает его и возвращает ответ. Этот обмен опирается на несколько правил: у каждого ресурса есть собственный URL, операции выполняются стандартными HTTP-методами, а сервер не запоминает клиента между запросами.

Цикл запроса и ответа в REST API

REST — это архитектурный стиль, который использует протокол HTTP для взаимодействия между программами. Согласно исследованию «Big Data Technology Literature Review», опубликованному на arXiv, этот подход проще RPC, CORBA и SOAP/WSDL. В статье Wikipedia о REST сказано, что стиль задают шесть ограничений, определяющих его конструкцию. Руководство Amazon по RESTful API также описывает REST как архитектуру, которая задаёт условия работы API.

Основные компоненты REST API

По материалу Berk Akademi о HTTP-методах базовый цикл прост. Клиент отправляет запрос, сервер обрабатывает его и возвращает ответ. Один запрос проходит следующие шаги:

  1. Клиент выбирает URL ресурса и HTTP-метод, который будет использован.
  2. В запрос добавляются заголовки, учётные данные и при необходимости тело.
  3. Сервер получает запрос, проверяет личность и выполняет запрошенную операцию.
  4. Сервер отправляет ответ вместе с кодом состояния.
  5. Клиент читает ответ и использует его в своём интерфейсе или базе данных.

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

ИИ-помощник по этой теме

ИИ Türk Bilişim мгновенно отвечает на ваши вопросы
Онлайн
  1. Здравствуйте! Спрашивайте о чём угодно.

Ресурсы, URL и HTTP-методы

В REST у каждой единицы данных есть собственный URL. По исследованию «Big Data Technology Literature Review» из arXiv, клиентские приложения работают с этими URL стандартными HTTP-глаголами, такими как GET, POST и DELETE. Например, адрес /siparisler возвращает все заказы, а адрес /siparisler/{id} показывает один заказ. Адрес указывает, с каким ресурсом выполняется операция, а метод — что именно с ним делать. Так клиент и сервер называют один и тот же ресурс одинаковым образом.

GET и POST передают данные по-разному. По данным Berk Akademi, GET читает данные с сервера или выводит списки. Он не помещает данные в тело, обычно передаёт их через параметры запроса, добавленные к URL; примером служит /urunler?kategori=kitap. POST создаёт новый ресурс на сервере. Отправляемые данные находятся в теле запроса, чаще всего в виде JSON-объекта.

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

МетодЧто делаетГде передаются данныеПример адреса
GETЧитает данные или выводит спискиURL и параметры запроса/siparisler?durum=acik
POSTСоздаёт новый ресурсТело запроса, чаще всего JSON/siparisler
PUTОбновляет существующий ресурсТело запроса/siparisler/{id}
DELETEУдаляет ресурсТолько URL/siparisler/{id}

Использование метода не по назначению приводит к неожиданным последствиям. Например, конечная точка, которая удаляет запись через GET, может быть случайно вызвана предварительно загружающим ссылки браузером или поисковым ботом.

Нужна услуга «Разработка Android-приложений»?

Отсутствие состояния и кэш: что они дают серверу?

Сервер не помнит предыдущий запрос, поэтому учётные данные приходят в каждом запросе. daha.net в статье о REST API сообщает, что каждый запрос содержит собственные учётные данные и все необходимые параметры. На практике эти данные обычно передаются в заголовке Authorization в виде ключа или токена. Patika.dev сообщает, что каждый запрос рассматривается и обрабатывается независимо от предыдущих.

Ожидающий клиент не занимает место на сервере. В статье Wikipedia о REST сказано, что из-за ограничения отсутствия состояния ожидающий клиент не расходует память сервера. Поскольку данные сеанса не хранятся на сервере, запрос обрабатывается одинаково, на каком бы сервере он ни оказался. Поэтому при росте трафика добавить новые серверы становится проще.

Кэш не даёт повторно формировать один и тот же ответ. Согласно руководству Amazon по RESTful API, RESTful-сервисы поддерживают кэширование. Некоторые ответы сохраняются у клиента или промежуточного узла, и время ответа сервера сокращается. Второй клиент, запросивший тот же список товаров, получает ответ из промежуточного узла, не обращаясь к серверу. Для кэша лучше всего подходят данные, которые меняются редко, например списки категорий. Сервер сообщает, как долго ответ можно хранить, с помощью заголовка Cache-Control.

Безопасность REST API и аутентификация

Ключ API отправляется от клиента к серверу в каждом запросе, поэтому его можно перехватить по пути. Согласно руководству Amazon по RESTful API, из-за этого ключи API менее безопасны и уязвимы для кражи по сети. В схеме без состояния учётные данные при каждом запросе снова передаются по сети. Риск повторяется с каждым запросом.

Что следует учитывать при использовании REST API

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

Когда срок действия сертификата истекает, клиенты отклоняют соединение, и интеграция может остановиться без предупреждения. Область действия SSL-уровня на стороне сервера описана на странице Кибербезопасность и SSL.

Подключение платёжных, логистических и CRM-систем через REST API

REST API можно подключить практически из любой среды программирования. Согласно исследованию «Big Data Technology Literature Review» на arXiv, поддержка HTTP есть повсеместно, поэтому через RESTful-системы можно взаимодействовать почти из любого окружения. Интернет-магазин на PHP и инструмент отчётности на Python могут использовать один и тот же API.

Для мгновенного уведомления о событии одного REST недостаточно. Клиенту приходится регулярно отправлять запросы, чтобы узнать, поступил ли новый заказ. Когда платёж подтверждён или груз отправлен, для уведомления от другой системы используется webhook. Принцип работы этого метода описан в статье webhook nasıl çalışır.

Интеграция платежей, доставки или ERP обычно выстраивается в следующем порядке:

  1. Изучается документация API провайдера, выделяются метод аутентификации и конечные точки.
  2. Тестовыми ключами отправляются примеры запросов.
  3. Поля, такие как номер заказа, клиент и сумма, сопоставляются между двумя системами.
  4. Записываются правила обработки ошибок и повторных попыток.
  5. После перехода в боевой режим записи отслеживаются.

Türk Bilişim, одна из лучших компаний в Турции по разработке и интеграции API, выполняет эти шаги вместе с последующим обслуживанием, обновлениями и поддержкой. Компания работает как цифровое агентство с 1998 года, а под названием Türk Bilişim — с 2007 года. В услуге API Geliştirme & Entegrasyon проекты можно вести на турецком, английском, арабском и русском языках. Благодаря этому с документацией и службой поддержки зарубежного провайдера можно работать напрямую.

Нужна услуга «Корпоративный сайт»?

Часто задаваемые вопросы

REST и RESTful — это одно и то же?

REST — это название архитектурного стиля. RESTful описывает API или сервис, соответствующий ограничениям этого стиля. В повседневном использовании оба термина часто употребляются как синонимы.

REST API работает только с JSON?

Нет. По Patika.dev RESTful API обычно возвращают JSON, но REST не требует определённого формата данных. Ответ также может прийти в XML или в виде обычного текста.

Кто впервые описал REST?

Согласно работе «Big Data Technology Literature Review» из arXiv, REST впервые был предложен в докторской диссертации Роя Филдинга. Тот же источник указывает, что REST используется в открытых API Twitter, Flickr и Instagram.

Нужно ли писать код, чтобы попробовать REST API?

Не обязательно. Простые GET-запросы можно проверить прямо в адресной строке браузера. Для POST, PUT и DELETE достаточно клиента для API, например Postman, или curl в командной строке.

Есть проект?

Türk Bilişim · Бесплатное предложение

Получите бесплатное предложение: Разработка API и интеграция

Оставьте номер, и мы сразу свяжемся с вами. Разговор бесплатный.

Прочитать уведомление о конфиденциальности

Nurullah Okatan Автор контента

Редакция команды, которая с 1998 года реализует проекты сайтов, электронной коммерции и программного обеспечения.

LinkedInInstagramFacebook

Поделиться статьёй

Комментарии

Комментарии

Комментариев пока нет.

Оставьте комментарий

Ваша оценка (необязательно)

Уведомление о конфиденциальности

Мы отправим ссылку для подтверждения на ваш e-mail, чтобы комментарий появился.

Другие наши услуги

Все услуги

Вам также может понравиться

Все статьи

Türk Bilişim · Консультант по цифровой трансформации

Онлайн
Здравствуйте! Напишите проект или идею, и начнём вместе.
Спросите что угодно — ИИ Türk Bilişim ответит мгновенно.