Как выбрать код состояния HTTP в REST API для «Пока не готов, повторите попытку позже»? [закрыто]

Я разрабатываю RESTful API, в котором http://server/thingyapi/thingyblob/1234для загрузки возвращает файл (он же «blob»), связанный с thingy # 1234. Но может случиться так, что запрос сделан в то время, когда файл не существует на сервере, но наиболее определенно будет доступен позже. На сервере есть пакетный процесс, который генерирует все BLOB-объекты для всех штук. Thingy 1234 уже существует, и его данные, кроме блоба, уже доступны. Серверу еще не удалось сгенерировать BLOB-объект штуковины 1234 года.

Я не хочу возвращать 404; это для штуковин, которых не существует. Это вещь, которая существует, но ее блоб еще не сгенерирован. Вроде как видео на YouTube это "обработка". Я не думаю, что коды перенаправления были бы правильными; нет «другого» URL, чтобы попробовать.

Какой правильный код статуса HTTP нужно вернуть в таком случае?

Я предлагаю 202 - Accepted. Из документации :

Запрос принят к обработке, но обработка не завершена. [...] Его цель - позволить серверу принять запрос для какого-либо другого процесса (возможно, пакетно-ориентированного процесса, который выполняется только один раз в день)

«Проблема», как она есть, на стороне сервера: клиент сделал правильно сформированный запрос, но сервер не может удовлетворить его. Так что я склонен к «Ошибка сервера», код состояния 5xx.

Quoth RFC 7231 (текущий стандарт HTTP, акцент добавлен):

Класс кода состояния 5xx (Ошибка сервера) указывает, что сервер знает, что он допустил ошибку или не может выполнить запрошенный метод . За исключением случаев ответа на запрос HEAD, сервер ДОЛЖЕН послать представление, содержащее объяснение ситуации с ошибкой, и является ли это временным или постоянным условием.

Заметка

• «ошибся или неспособен выполнить запрос»: несмотря на название «Ошибка сервера», они относятся не только к ошибкам сервера.
• « временный или постоянный»: эти коды подходят для временно недоступных ресурсов, таких как ваш.

Из доступных кодов, я бы сказал, 503, «Служба недоступна» как нельзя лучше подходит:

Код состояния 503 (служба недоступна) указывает, что сервер в настоящее время не может обработать запрос из-за временной перегрузки или планового обслуживания, которое, вероятно, будет облегчено после некоторой задержки. Сервер МОЖЕТ отправить поле заголовка Retry-After ..., чтобы предложить клиенту соответствующее время ожидания, прежде чем повторять запрос.

Примечание:

• «вероятно, будет облегчен после некоторой задержки»: верно для вашего случая.
• «временная перегрузка»: не подходит для вашего случая. Но можно утверждать, были сервер намного быстрее, чем пакетная обработка будет уже сделано , когда клиент сделал запрос, так что это своего рода «перегрузки»: клиент запрашивает ресурсы быстрее , чем сервер может сделать их в наличии.
• Повторная попытка подходит для вашего обслуживания, поэтому ваш ответ должен содержать Retry-Afterзначение. В качестве значения можно указать предполагаемое время завершения следующего выполнения пакетного процесса или интервал выполнения пакетного процесса.

Определение собственного кода статуса 5xx (например, 591), хотя и разрешено , будет иметь неверную семантику:

клиент ДОЛЖЕН понимать класс любого кода состояния, как указано первой цифрой, и обрабатывать нераспознанный код состояния как эквивалентный коду статуса x00 этого класса

Клиенты будут рассматривать ваш собственный код состояния как 500, «Внутренняя ошибка сервера» , что было бы неправильно.

Я думаю, что 423 - Locked можно использовать для этой цели:

Код состояния 423 (заблокирован) означает, что источник или целевой ресурс метода заблокирован. Этот ответ ДОЛЖЕН содержать соответствующий код предусловия или постусловия, такой как «lock-token-submit» или «no-конфликтаing-lock».

Я не хочу возвращать 404; это для штуковин, которых не существует.

URL не соответствует запросу на штуку.

http://server/thingyapi/thingyblob/1234

Клиент запрашивает штуковину, которой не существует. Если бы он существовал, вы бы дали его им.

404.

Другой вариант: 503 - Service Unavailable.

Поскольку ваш ресурс не готов, вы, вероятно, знаете, когда (приблизительно) он будет доступен и когда клиент может повторить свой запрос. Это означает, что вы можете использовать заголовок Retry-After . Этот заголовок действителен с 503 (служба недоступна), что означает, что весь сайт не работает для обслуживания, и с ответами 3xx (перенаправление).

По моему мнению, 302 (найдено) с заголовком Retry-After будет лучшим вариантом, но я не уверен, может ли поле Location заголовка ответа быть равно URL запроса. В любом случае, это круговое перенаправление.

409 Конфликт

Указывает, что запрос не может быть обработан из-за конфликта в запросе, такого как конфликт редактирования в случае нескольких обновлений. [Источник Википедии.]

Это может быть уместно.

Если вы не можете выполнить запрос, вернув данные - это не удача. Я думаю, что 202 предполагает, что сервер поставил в очередь запрос, и он выполнит запрос позже. Но в вашем случае запрос для данных сейчас и не удалось. Если вы повторите попытку позже, это другой запрос.

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

501 - не реализовано

Точно так же, как это звучит. Функция, которая еще не реализована, но подразумевает доступность в будущем.

Вот ссылка на резюме ошибок 5xx .