Дизайн обслуживания отдыха один к одному

Question

Сценарий: Мы создаем/планируем службу REST, чтобы помочь нам настроить систему (и ее сеть и т. Д.), Но мы столкнулись с некоторыми проблемами, связанными с проектированием этого API. Мы хотели бы настроить имя хоста системы с помощью вызова REST/

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

В настоящее время мы рассматриваем, используя что-то вроде:

• GET /system/0
• PUT /system/0 {....}

Проблема: Существует только одна система сущность, так что не чувствует себя хорошо, чтобы определить это использование 0, потому что есть только один из них.

Есть ли какие-либо рекомендации REST о том, как это должно быть сделано?

Answer 1

На самом деле, REST не применяет конкретный формат для URL-адреса, у вас даже может быть URL-адрес, такой как /569284d7-1b59-4343-92d4-90e8753bcbd7, и все в порядке. В REST сервер управляет клиентом с помощью изменений состояния, а не о том, что клиент знает, какие URL-адреса будут доступны.

Большинство веб-API, созданы в стиле CRUD, с иерархией ресурсов, как ваш пример /system/0, /system/1, потому что это легче понять и внедрить (не всегда может быть RESTful в зависимости от того, насколько плотно связь с клиентом для URL-адресов , но он удовлетворяет большинство потребностей, поэтому люди решили сделать это так).

Таким образом, мой совет будет заключаться в том, чтобы сохранить его простым и не переутомлять. Использование /system/0 в порядке, даже если теперь у вас есть только одна система.

Только мои 2 цента!