Каким должно быть API, чтобы оно считалось RESTful

RESTful API должно соответствовать принципам REST (Representational State Transfer):

1. Клиент-серверная архитектура – разделение клиента и сервера для независимого масштабирования.

2. Stateless – каждый запрос содержит всю необходимую информацию, сервер не хранит состояние клиента.

3. Кэширование – ответы должны явно указывать, можно ли их кэшировать.

4. Единообразие интерфейса – стандартизация взаимодействия:

   • Ресурсы идентифицируются URL (например, /users/123)
   • Использование HTTP методов (GET, POST, PUT, DELETE)
   • Ресурсы представлены в форматах JSON/XML

5. Слоистая система – клиент не знает, взаимодействует ли он напрямую с сервером или через промежуточные узлы.

Пример RESTful эндпоинта:

# Получение пользователя
GET /api/users/1
# Создание пользователя
POST /api/users
# Обновление
PUT /api/users/1
# Удаление
DELETE /api/users/1

Критерии хорошего RESTful API: понятные URL, правильные HTTP коды (200, 201, 404 и т.д.), версионирование (/v1/users), фильтрация через query-параметры (/users?active=true).