Принципы REST - возврат простого ответа

Question

Я работаю с картой Django REST. По умолчанию все запросы возвращают объект JSON, содержащий разбивку на страницы (prev, next, count, results). Это полезно в 90% случаев, когда пользователь извлекает или создает информацию о чем-то. Однако есть несколько ресурсов, которые не должны возвращать ничего, а скорее подтверждение того, что все прошло гладко - например, представьте себе ресурс, который является просто запросом heartbeat («ping») для поддержания активного сеанса.

Не могли бы вы вернуть простой ответ, например {result: true} (без какой-либо разбивки на страницы, как и для остальных ресурсов) или это было бы возможным нарушением принципов REST?

Answer 1

Да, конечно, такой ответ на запрос ping в порядке. Пагинация - это то, что подходит только для коллекции, которая может быть выгружена. Пейджинг Уникальный ресурс, который не является коллекцией, не имеет смысла.

Для запроса ping вы даже можете оставить корпус ответа пустым.

Запрос:

GET /ping 

Ответ:

200 OK 
Content-Length: 0 

Answer 2

Если все вы хотите знать, если URI полностью исправен, полностью игнорируя тело, вы должны просто поддерживать HEAD запрос вместо GET.

Answer 3

Пагинация должна быть решена с помощью заголовков диапазонов или гиперссылок. Тебе не нужно тело в пустых ответах, просто заголовок состояния.