RESTful API сортировки дилемма

Question

У меня есть REST API реализован в соответствии с принципом, что остальные просто возвращает основные документы и ссылки в этих документах Howto получить другие вещи, и т.д. и т.п.

Например/автомобиль/5 даст мне модель: blabla, user_id: 1, а затем, если вам нужен владелец, вы получите/user/1, чтобы получить пользовательские данные.

Этот способ СОХРАНЕНИЯ и прочее избегают в БД .. все вещи связаны между собой и взаимосвязанными данными на клиентской части отдыха - хранение вещей прост легко кешировать/удалять кеш, масштаб и т. д.

Но что происходит, когда вам нужна сортировка?

Представьте, что у нас есть представление о интерфейсе для отображения следующих данных: Модель автомобиля, имя пользователя и т. Д. ... и вы хотите сортировать по имени пользователя, например.

Вы не можете действительно сказать/автомобиль/5 сортировать по имени пользователя потому что знает только пользовательских идентификаторов ...

Один из вариантов я вижу сортирует от пользователя/пользователя/список? SortBy = имя пользователя и затем соединение между этими возвращенными идентификаторами действительно относится к автомобилю. но это означает, что нам нужно получить ВСЕ пользователей ... и использовать только часть тех, которые кажутся узким местом убийцы.

Спасибо за любые указатели

Answer 1

Я думаю, что вы пытаетесь избежать присоединения по всем неправильным причинам, так как при таком подходе, вы будете иметь, чтобы обслуживать гораздо больше запросов.

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

Другой вариант - вернуть дочерние объекты в виде дочерних элементов XML (аналогично тому, как работает интерфейс RESTful OpenStreetMap). У вас все еще есть один клик от клиента, и вы должны иметь возможность оптимизировать запросы, чтобы минимизировать нагрузку на БД.

Answer 2

Если вы избегаете всех подключений на сервере и оставляете его клиенту, тогда в этом случае вы также должны оставить сортировку клиенту. Это связано с тем, что для сортировки автомобилей по имени пользователя необходимо выполнить соединение.

Вы можете создать другой ресурс, называемый CarsAndOwners или аналогичный, который возвращает объединенный список, после чего становится разумным сортировать на сервере.

Answer 3

Я хотел бы начать, представляя идеальный RESTful запрос, который я хотел бы написать, например:

/car/list?sortby=username 

А затем выяснить, как осуществить это.

Теперь ваш список метод дает автомобиля объектов, которые не разоблачить имени как вы сказали, но я не думаю, что имеет значение. Вся сортировка должна выполняться на сервере до того, как будет подготовлен список.

Вы будете нуждаться, чтобы присоединиться к вашему автомобилю объектов пользователя объектов в каком-то момент для того, чтобы сделать это, и нет никакого способа уворачиваясь этого вопроса. Единственный выбор, который у вас есть, - это то, где вы это делаете.

Если вы работаете с традиционной РСУБД, имеет смысл сделать это на уровне БД.

Вы используете слой ORM между API приложения и базой данных?

Answer 4

Прежде всего, ваш пример /car/5 должен быть множественную версию ресурса для того, чтобы быть RESTful:

/cars/5 
/users/1 

Теперь, в общем, если вы хотите RESTful подход к сортировке вы можете сделать это:

/cars?sort=make&order=asc 

В вашем примере вы указываете, что хотите сортировать автомобили по имени пользователя. Однако, как вы упомянули, коллекция cars ничего не должна знать о users. Итак, если вы хотите отобразить список автомобилей и сгруппировать их по пользователю, что вы будете делать? Вам нужен способ получить эту информацию. Один из способов сделать это является проходным пользователей и запрашивать машины, связанные с каждым пользователем:

# pseudo code 

users.each do |user| 
    # assuming the user id is 5, 
    # to display the user's cars, 
    # we need to request /users/5/cars 
end 

Таким образом, мы можем запросить список автомобилей для каждого человека в URL, как /users/5/cars. Это называется вложенным ресурсом. Мы запрашиваем только те автомобили, которые связаны с пользователем. 5.

Однако, у вас есть проблема с потенциально большим количеством запросов к вашему API (что может быть в порядке в зависимости от вашего варианта использования).

Другой подход, который, вероятно, лучше, чтобы сделать это в одном запросе на:

/users/cars?sort=username&order=asc 

будет возвращен массив пользователей и их автомобилей по заказу пользователя.

И еще один подход может быть:

/users?include=[cars]&sort=username&order=asc 

, но я не люблю этот подход, как много, как и предыдущий. Я бы рекомендовал предыдущий подход /users/cars.

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

/users?page=1&per_page=50 

Answer 5

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

Почти все, что я читал в REST, говорит о том, что отношения между сущностями/ресурсами также должны быть ресурсом. Поэтому у вас должен быть ресурс /mydomain.com/CarsAndUsers, который представляет это соединение/отношения.

Затем вы можете сделать сортировку по этому ресурсу так же, как и любой другой, и он будет обработан в базе данных:

/mydomain.com/CarsAndUsers?sortby=username

Вы также можете применить фильтрацию этот ресурс (и пейджинг), как и любой другой ресурс.

EDIT:

Согласно комментариям, было бы лучше сделать что-то вроде этого:?

/автомобили встраивать = пользователь, SortBy = имя пользователя

Спасибо Эрик за указание это из.