RESTful дизайн URL для поиска - PullRequest
Новая
       45

RESTful дизайн URL для поиска

395 голосов
/ 16 октября 2008

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

Установка: у меня есть две модели, Автомобили и Гаражи, где Автомобили могут быть в Гаражах. Так что мои URL выглядят так: 

/car/xxxx
  xxx == car id
  returns car with given id

/garage/yyy
  yyy = garage id
  returns garage with given id

Автомобиль может существовать сам по себе (отсюда и / автомобиль) или в гараже. Как правильно представлять, скажем, все машины в данном гараже? Что-то вроде: 

/garage/yyy/cars     ?

Как насчет объединения автомобилей в гараже yyy и zzz?

Как правильно представлять поиск автомобилей с определенными атрибутами? Скажи: покажи мне все синие седаны с 4 дверями: 

/car/search?color=blue&type=sedan&doors=4

или это должно быть / автомобили вместо?

Использование «поиска» здесь неуместно - что лучше / термин? Должно ли это быть просто: 

/cars/?color=blue&type=sedan&doors=4

Должны ли параметры поиска быть частью PATHINFO или QUERYSTRING?

Короче, я ищу руководство для кросс-модели REST url и поиска.

[Обновить] Мне нравится ответ Джастина, но он не охватывает случай поиска в нескольких полях: 

/cars/color:blue/type:sedan/doors:4

или что-то в этом роде. Как мы идем от 

/cars/color/blue

в случае нескольких полей?

Ответы [ 12 ]

0 голосов
/ 15 сентября 2017

Есть много хороших вариантов для вашего случая здесь. Тем не менее, вы должны рассмотреть возможность использования тела POST.

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

Это позволяет более гибко описывать поиск, а также позволяет избежать ограничения длины URL-адреса сервера.

0 голосов
/ 16 октября 2008

Мой совет будет таким: 

/garages
  Returns list of garages (think JSON array here)
/garages/yyy
  Returns specific garage
/garage/yyy/cars
  Returns list of cars in garage
/garages/cars
  Returns list of all cars in all garages (may not be practical of course)
/cars
  Returns list of all cars
/cars/xxx
  Returns specific car
/cars/colors
  Returns lists of all posible colors for cars
/cars/colors/red,blue,green
  Returns list of cars of the specific colors (yes commas are allowed :) )

Edit: 

/cars/colors/red,blue,green/doors/2
  Returns list of all red,blue, and green cars with 2 doors.
/cars/type/hatchback,coupe/colors/red,blue,green/
  Same idea as the above but a lil more intuitive.
/cars/colors/red,blue,green/doors/two-door,four-door
  All cars that are red, blue, green and have either two or four doors.

Надеюсь, это дает вам идею. По сути, ваш Rest API должен быть легко обнаруживаем и должен позволять вам просматривать ваши данные. Еще одним преимуществом использования URL-адресов, а не строк запроса, является то, что вы можете использовать встроенные механизмы веб-сервера для кэширования HTTP-трафика.

Вот ссылка на страницу, описывающую зло строк запроса в REST: http://web.archive.org/web/20070815111413/http://rest.blueoxen.net/cgi-bin/wiki.pl?QueryStringsConsideredHarmful

Я использовал кеш Google, потому что у меня не работала обычная страница, вот и эта ссылка: http://rest.blueoxen.net/cgi-bin/wiki.pl?QueryStringsConsideredHarmful

Страница:
...