Как разрешить пользователю создавать/обновлять объемные данные и сохранять спокойствие?

Question

Я создаю веб-API, и у меня есть сценарий, когда пользователи захотят загружать кучу данных навалом, которые затем будут загружаться в базу данных в виде нескольких отдельных записей. Эти данные могут быть совершенно новыми и, следовательно, созданы, или данные могут уже существовать и, таким образом, обновляться. Определения для POST и PUT, похоже, ожидают работать только с одним фрагментом данных, а созданный код состояния отражает это при предоставлении местоположения.

У меня уже есть методы, которые позволяют создавать или обновлять один кусок данных. Должен ли я писать дополнительные методы для облегчения создания и обновления этих объемных данных или я должен ожидать, что пользователь сделает индивидуальные вызовы (возможно, сотни тысяч раз) для загрузки своих данных? Что я должен возвращать в отношении кодов состояния и других данных? Какие глаголы запроса должны определять эти массовые вызовы?

Answer 1

Способ RESTful для создания нескольких элементов внутри коллекции - использовать PUT для всей коллекции.

Таким образом вы делаете запрос на замену всей коллекции, поэтому вам необходимо передать как старые, так и новые элементы, но новые будут созданы сервером.

Предположим, у вас был только один элемент в коллекции предметов, называемый «старый элемент». Здесь вы запрашиваете обновление коллекции, чтобы иметь два новых элемента.

PUT /items 

[{ Name: "old item"}, { Name: "new item 1"}, { Name: "new item 1"}] 

Вам не нужно возвращать любое содержимое внутри успешного ответа PUT, потому что успех в данном случае означает, что точное состояние Запрашиваемый вами был применен. Поэтому он оставляет код состояния 204.

И так как вы обновляете весь комплект ресурс, вы не возвращаете 201 независимо от того, были ли созданы новые объекты или нет.