REST-сервисы в системе

REST (Representational State Transfer) — стиль построения архитектуры распределенного приложения.

Для передачи данных используются стандартные форматы, например, HTML, XML, JSON.

Сетевой протокол (как и HTTP) поддерживает кэширование, не зависит от сетевого слоя и удаляет информацию о состоянии между парами "запрос-ответ", что обеспечивает масштабируемость системы и позволяет ей эволюционировать с новыми требованиями.

Обращение к серверу происходит по протоколу HTTP 1.1.

В зависимости от требуемых операций используются различные методы обращения:

  • Создание объектов: GET, POST.
  • Редактирование объекта: GET, PUT, POST.
  • Получение объекта, списка объектов: GET.
  • Удаление объекта: GET, POST, DELETE.
  • Выполнение скриптов: POST.
  • Прикрепление файла: POST.

Раздел рассчитан на пользователя, обладающего уверенными навыками работы с компьютером и веб-интерфейсом, обладающего навыками работы c интерфейсом программирования приложений (API).

Содержание раздела:

  • Работа с REST-сервисами в системе

    Формат адреса для выполнения REST-методов. Получение базового URL-адреса приложения. Получение ключа для доступа. Формирование ссылок для доступа к методам. Логирование REST.

  • Методы REST API

    В разделе приводится описание методов REST API для SMP.

  • Форматы передачи атрибутов и их значений в методах REST API

    В методы create, create-m2m, edit, edit-m2m, find атрибуты и их значения передаются унифицировано в различных форматах.

    В разделе приведен полный список поддерживаемых форматов передачи атрибутов и их значений. Другие форматы передачи, например, с использованием multipart/form-data, в методах create, create-m2m, edit, edit-m2m, find не поддерживаются.

 

Cмотри также: