rest api ожидаемый ответ для GET

Question

Я работаю над созданием отдыха api, и у меня есть вопрос о том, что обычно возвращается из get без соответствия. Например, если мой ресурс «пользователи», и я сделать апи вызов метода

Http: ПОЛУЧИТЬ URL: api.mysite.com/users/123

Если «123» существует Я вернёт HTTP код 200 с деталями пользователя в теле ответа. Мой вопрос: какой http-код я должен вернуть, и что я должен поместить в тело ответа, если нет пользователя с идентификатором 123?

Должен ли я просто вернуть код 200 и пустой корпус?

Answer 1

Используйте , так как запрошенный ресурс (Пользователь) не существует.

10.4.5 404 Не найдено

Сервер ничего совпадающий с Request-URI не найден. Нет Указывается, является ли условие временным или постоянным. Код состояния 410 (Gone) СЛЕДУЕТ использоваться, если сервер через некоторый механизм внутренней конфигурации знает, что старый ресурс постоянно недоступен и не имеет адреса пересылки. Этот код состояния обычно используется, когда сервер не желает точно определить, почему запрос был отклонен, или когда не применяется другой ответ . RFC 2616

• Better Rest API design 2
• RESTful resource not found. 404 or 204? Jersey returns 204 on null being returned from handler
• When to use HTTP status code 404 in an API

Answer 2

Как ваш API, так что вы можете возвращать все, что хотите, но если вы говорили о стандарте ответов HTTP, я бы предложил вам вернуть 404 (NOT FOUND) в этом случае, который выглядит более подходящим в этом случае. Поскольку ресурс, к которому вы пытаетесь получить доступ, недоступен в этом месте.

404- Not Found подразумевает, что сервер не нашел ничего, что соответствует Request-URI.

С кодом состояния 404 вы также можете предоставить тело ответа или любой другой значимый заголовок с надлежащим сообщением об ошибке. Так что клиент может это понять.