2017-01-18 6 views
0

Я создаю простой API для проверки членства. Клиент должен будет ввести идентификатор строки, а сервер будет проверять, является ли идентификатор действительным членом нашего сообщества, скажем, сообщества. Идентификатор должен быть только числовым, с длиной 10.REST HTTP Status Code Лучшая практика для проверки API

Довольно простое право?

Если идентификатор действителен, мы обязательно вернем код состояния HTTP OK. Если идентификатор содержит alfabet, или меньше/больше 10, то мы вернем код HTTP-кода BAD REQUEST.

Вопрос в том, какой лучший практический код состояния HTTP для возврата, когда идентификатор является числовым и длина = 10, но НЕ является членом нашего сообщества? и почему так.

+0

Well II не знаю, является ли это лучшей практикой, но я бы вернул код статуса HTTP NOT_FOUND (404), потому что все проверки проверки прошли, но запись с этим идентификатором не найдена в вашем сообществе –

ответ

0

Конечные точки REST API, как правило, являются ресурсами, на которых вы работаете с использованием HTTP-методов, таких как GET, PUT, POST, DELTE. Когда вы это делаете, гораздо проще решить, какой статус HTTP вернуть.

Так может быть, вы могли бы сделать в конечной точке

/member/{id} 
  • если член с этим идентификатором существует, возвращать HTTP 200, и если вы хотите, чтобы некоторые JSON с информацией основного члена
  • , если идентификатор является действительным , но ни один член не существует, возвращать HTTP 404 - нЕ НАЙДЕНО
  • , если идентификатор не является действительным, длина = 10 или содержит недопустимые символы, возвращает HTTP 400 BAD REQUEST

Здесь вы можете найти более подробную информацию о REST API design