Веб-сервисы RESTful - лучший способ вернуть результат операции?

Question

Я разрабатываю RESTful API, и я хотел бы знать, какой самый RESTful способ вернуть подробности об операции.

например. Операция над ресурсом происходит, когда некоторые данные помещаются в URL. Коды состояния HTTP будут указывать либо на успех, либо на сбой операции. Но помимо успеха / неудачи мне нужно указать клиенту некоторую другую информацию, например, идентификационный номер.

Итак, мой вопрос: должен ли идентификационный номер возвращаться в XML-документе в содержимом ответа или в некоторых настраиваемых полях заголовка HTTP? Что больше соответствует принципам REST? Или я могу выбирать.

Answer 1

Возврат сущности является совершенно верным ответом на HTTP POST.

Вам также не нужно возвращать XML, вы можете просто использовать тип содержимого text / plain и просто вернуть строковое значение.

Использование заголовка потребует от вас определения нового пользовательского заголовка, который не идеален. Я ожидаю, что клиентам будет проще проанализировать тело ответа, чем извлекать информацию из заголовка.

Answer 2

Если это просто идентификационный номер, это сэкономит накладные расходы, чтобы сделать это просто как заголовок HTTP. Создание правильного XML-документа только для одного числа добавило бы к запросу гораздо больше накладных расходов.

Answer 3

XML-документ имеет наибольшее значение.