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

Question

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

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

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

Answer 1

Возврат объекта является вполне допустимым ответом на HTTP POST.

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

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

Answer 2

XML-документ имеет наибольший смысл.

Answer 3

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