re:re:actable
Урок 012 минуты чтения

Что такое REST?

На этой странице
Кратко

REST - архитектурный стиль для проектирования API вокруг ресурсов. В REST важны resources, representations, HTTP methods, status codes, stateless communication и единый interface.

Вопрос

Что такое REST? Какие принципы лежат в его основе и чем он отличается от RPC-подхода?

Главная идея

REST API не должен выглядеть как набор удаленных функций:

POST /getUser
POST /createUser
POST /deleteUser

Он должен описывать ресурсы:

GET    /users
POST   /users
GET    /users/42
PATCH  /users/42
DELETE /users/42

users - ресурс. Method показывает действие.

Resource и representation

Resource - сущность или коллекция в системе:

  • user;
  • article;
  • order;
  • comment;
  • session.

Representation - то, как ресурс представлен в response, например JSON:

{
  "id": 42,
  "email": "anna@example.com"
}

Stateless

Каждый request должен содержать достаточно информации для обработки.

Server не должен зависеть от "предыдущего request в этом соединении". Если нужна identity пользователя, она передается через session cookie, token или другой auth mechanism.

Uniform interface

REST старается использовать единый смысл HTTP:

  • GET читает;
  • POST создает;
  • PATCH обновляет часть;
  • DELETE удаляет;
  • status code сообщает результат.

Что важно помнить

  • REST — архитектурный стиль (Roy Fielding, 2000), а не протокол или стандарт. Большинство «REST API» на практике реализуют его частично.
  • Ограничения REST: client-server, stateless, cacheable, uniform interface, layered system и необязательный code on demand.
  • Альтернативы: GraphQL (клиент сам выбирает поля), gRPC и tRPC (вызов процедур с типизацией) — у каждой свои компромиссы.
  • Хороший REST API документируют в OpenAPI (Swagger): из схемы можно сгенерировать типы и клиент для frontend.

Мини-шпаргалка

  • REST строится вокруг resources.
  • URL называет ресурс, method называет действие.
  • Response возвращает representation.
  • REST stateless.
  • Status codes и headers - часть контракта API.

Документация

MDN: REST, OpenAPI Specification.

Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.

Поиск

Поиск по урокам