Какие паттерны проектирования API существуют?

Question

Существуют разные паттерны, которые помогают делать API понятным, расширяемым и удобным для поддержки.
Наиболее известные паттерны — REST, RPC, GraphQL, gRPC и Webhooks.
Они различаются способом передачи данных, форматом взаимодействия и степенью гибкости.
Новичку важно понимать, в чём сильные и слабые стороны каждого подхода.
Чаще всего выбирают REST или gRPC, в зависимости от задачи.

YeaHub · Accepted Answer

Паттерны проектирования APIСуществуют несколько распространённых подходов к построению API, каждый из которых решает конкретные задачи и подходит для разных сценариев.1. REST (Representational State Transfer)Определение: стиль архитектуры API, основанный на использовании HTTP-методов и ресурсов.Прост в реализацииПодходит для большинства CRUD-системХорошо работает с кэшированиемДанные обычно передаются в JSONПример запроса:GET /users/1
Когда применять: когда нужен простой, понятный, стандартизированный HTTP-интерфейс.2. RPC (Remote Procedure Call)Определение: модель API, где клиент вызывает удалённые функции как локальные.Минимум абстракцийХорош для внутренних микросервисовМожет использовать HTTP или бинарные протоколыПример:{"method": "get_user", "params": {"id": 1}}
Когда применять: когда важна скорость и простота вызовов.3. GraphQLОпределение: язык запросов, позволяющий клиенту выбирать, какие данные ему нужны.Избегает «overfetching» и «underfetching»Хорош для сложных UIТребует схемыПример:query {
  user(id: 1) { id name }
}
Когда применять: когда клиентам требуется гибкость в запросах.4. gRPCОпределение: высокопроизводительный бинарный протокол поверх HTTP/2.Очень быстрыйСтрогая типизацияТребует .proto-описанийПример:service UserService {
  rpc GetUser (UserRequest) returns (UserResponse);
}
Когда применять: при взаимодействии микросервисов, где нужна скорость.5. WebhooksОпределение: механизм, позволяющий серверу отправлять события клиенту.Работает по push-моделиПолезен для асинхронных уведомленийКогда применять: когда нужно реагировать на события в реальном времени.