Rest API

Rest API определяет набор функций, к которым разработчики могут совершать запросы и получать ответы. В сервисах Rest API используется, пожалуй, самый доступный для понимания способ представления информации.

Для быстрой и стабильной работы Rest API иногда приходится тратить немало времени, чтобы качественно спроектировать сам сервис Rest API. Очень часто встречаются ситуации, когда проект готов, однако срочно понадобился сервис. В этом случае разработчик ускоренными темпами выполняет реализацию сервера, не придерживаясь Rest API и обходясь GET и POST запросами.

Главное, что надо помнить при разработке Rest API, это версия сервиса. Ваш сервис будет развиваться и совершенствоваться, и придёт время, когда версия станет неактуальной. Поэтому сразу укажите в url строке указание версии API. При названии ресурсов сервиса Rest API, используйте имена существительные, ане глаголы и давайте имена во множественном числе.

Обязательно возвращайте подробное описание о любой ошибке. Когда происходит ошибка, возвращайте описание данной ошибке вместе с ошибочным кодом завершения. Придерживайтесь этих простых правил и разработка сервиса Rest API пройдёт быстро и непринуждённо.