Чи нормально REST повертати вміст після POST?

Я використовую RESTlet і створив ресурс. Я обробляю POST методом заміщення acceptRepresentation.

Клієнт повинен надіслати мені деякі дані, потім я зберігаю їх у БД, встановлюю відповідь 201 (SUCCESS_CREATED), і мені потрібно повернути деякі дані клієнту, але тип повернення acceptRepresentationє void.

У моєму випадку мені потрібно повернути якийсь ідентифікатор, щоб клієнт міг отримати доступ до цього ресурсу.

Наприклад, якщо у мене був ресурс з URL-адресою, /resourceі клієнт надсилає запит POST, я додаю новий рядок у БД і його адреса повинна бути /resource/{id}. Мені потрібно відправити {id}.

Я щось роблю не так? Чи дозволяють принципи REST повернути щось після POST? Якщо так, то як я можу це зробити, і якщо ні, то який спосіб вирішити цю ситуацію?

REST просто говорить, що ви повинні відповідати єдиному інтерфейсу. Іншими словами, там сказано, що ви повинні робити те, що повинен робити POST відповідно до специфікації HTTP . Ось цитата з цієї специфікації, яка є релевантною,

Якщо на вихідному сервері було створено ресурс, відповідь ПОВИНЕН бути 201 (Створений) і містити сутність, яка описує стан запиту та посилається на новий ресурс, та заголовок Location (див. Розділ 14.30).

Як видно з цього, у вас є два місця, де ви можете вказати клієнту, де знаходиться новостворений ресурс. Заголовок Location повинен мати URL-адресу, яка вказує на новий ресурс, і ви також можете повернути сутність із деталями.

Я не впевнений, у чому різниця між перевизначенням acceptRepresentation () та перевизначенням post (), але цей приклад показує, як повернути відповідь з POST.

Я б відмовився надсилати що-небудь у тілі відповіді. Просто встановіть для Location: (повну) URL-адресу новоствореного ресурсу.

Ваш опис свідчить про те, що це саме така семантика:

1. Опублікуйте щось, щоб створити його
2. Відповідь достатньо, щоб знати дві речі:
   1. Що сталося творіння (201)
   2. Де знайти нову річ (заголовок Location)

Все інше зайве.

Два різні запитання:

Чи підтримує шаблон програми REST повернення даних у POST?

Я не думаю, що REST явно забороняє це, але бажаний спосіб лікування прописаний у відповіді Даррела.

Чи дозволяє рамка RESTlet повернення даних у POST?

Так, навіть якщо воно повертає void, у класі, що розширює Resource, ви маєте повний доступ до об'єкта Response за допомогою методу getResponse (). Таким чином, ви можете викликати getResponse (). SetEntity () з будь-якими даними, які ви хочете.

Виведіть його в будь-якому запитаному форматі. Це може бути:

<success>
    <id>5483</id>
</success>

Або:

{ "type": "success", "id": 5483 }

Це залежить від того, що ти зазвичай робиш. Якщо вони не очікують даних, вони повинні просто проігнорувати їх, але будь-який клієнт, який хоче обробляти їх належним чином, повинен мати можливість.

Якщо ви відповідаєте 201 Створено тілом сутності, а не перенаправленням Розташування, то доцільно включити заголовок Content-Location, що вказує на ресурс, який представлений у відповіді.

Це дозволить уникнути потенційної плутанини - при якій клієнт може (виправдано) припустити, що сутність відповіді насправді представляє новий стан «творця», а не створений ресурс.

> POST /collection
> ..new item..

< 201 Created
< Location: /collection/1354
< Content-Location: /collection/1354
< <div class="item">This is the new item that was created</div>