AACSearch
ГлоссарийРазработка и API

REST

Что такое REST и как устроен этот стиль API.

REST

REST — распространённый стиль API поверх HTTP. Он описывает ресурсы URL-адресами, а действия над ними — HTTP-методами.

Основные принципы

  • ресурсы адресуются путями: /indexes, /indexes/products;
  • методы задают действие: GET — прочитать, POST — создать, PUT/PATCH — изменить, DELETE — удалить;
  • ответы приходят в простых форматах, обычно JSON;
  • каждый запрос самодостаточен — сервер не хранит состояние клиента.

Почему это удобно

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

AACSearch построен на REST: одни и те же эндпоинты обслуживают и виджет, и SDK, и ваш собственный код.

On this page