REST service URI design

Question

Я создаю службу RESTful, которая должна возвращать коллекцию элементов, но также должна иметь возможность фильтрации по нескольким индексам (местоположение, компания и категория). Эти фильтры могут применяться по отдельности или в любой комбинации. Это ситуация, когда использование фильтров, применяемых в строке запроса, имеет смысл? (что-то вроде: /items?company={}&location={}&category={}) Есть ли лучший способ передать фильтры ресурсу?

Answer 1

Предпочтительным способом передачи параметров поиска является использование строки запроса (действительно, именно поэтому она называется строкой запроса).Путь идентифицирует определенный ресурс, который вы хотите (индекс элементов).Строка запроса может включать, например, условия фильтрации, которые используются для изменения представления ресурса, но это все тот же ресурс (индекс элементов), поэтому путь должен быть таким же.

Answer 2

Это предпочтительный способ в среде REST.Вы могли бы переменные POST с фильтром, но это нарушило бы принципы REST (адрес должен представлять ресурс).

Рассматривали ли вы использование Службы данных WCF ?Это делает многое для вас "из коробки" в соответствии со стандартами.

Answer 3

Одно простое правило будет охватывать большинство, если не все хорошие практики;

If your filter parameters are optional then they should go to query string, 
if some filters are mandatory you may wanna put them into path. 
Adding optional params to path is not a good idea.

Answer 4

В вашей таблице маршрутов вы можете сделать что-то вроде этого:

"items/company/{organizationId?}/{locationId?}/{category?}"

и ваш контроллер будет выглядеть следующим образом:

public virtual ActionResult Get(string organizationId, string locationId, string category) {
...
}

На мой взгляд, это лучше, чем строки запросов, так как его гораздо легче обнаружить.