Какой метод HTTP и какие параметры следует использовать для получения списка сущностей с возможностью фильтрации, пагинации и сортировки?

Question

Для получения списка сущностей используется HTTP GET метод. Параметры передаются через query string: фильтрация - по именам полей (status=active&category=books), пагинация - page, limit или offset, limit, сортировка - sort с указанием поля и направления (sort=name:asc). Дополнительно используются параметры для выбора полей (fields=id,name).

YeaHub · Accepted Answer

Базовый подходHTTP методGET - для безопасного и идемпотентного получения данныхБазовый URLtextGET /api/resourcesПараметры фильтрацииПростая фильтрация по полямtextGET /api/users?status=active&role=adminОператоры сравненияtextGET /api/products?price_gt=100&price_lt=500
GET /api/orders?date_from=2023-01-01&date_to=2023-12-31Поиск по текстуtextGET /api/articles?q=rest+apiФильтрация по отношениямtextGET /api/posts?author_id=123
GET /api/comments?post.category=technologyПараметры пагинацииPage-based пагинацияtextGET /api/users?page=2&limit=20Offset-based пагинацияtextGET /api/users?offset=40&limit=20Cursor-based пагинация (для больших наборов)textGET /api/users?cursor=abc123&limit=20Параметры сортировкиПростая сортировкаtextGET /api/users?sort=name
GET /api/users?sort=created_at:descМножественная сортировкаtextGET /api/products?sort=category:asc,price:descРасширенные возможностиВыбор полей (Field selection)textGET /api/users?fields=id,name,emailВключение связанных данныхtextGET /api/posts?include=author,commentsПример полного запросаhttpGET /api/products?
  category=electronics&
  price_min=100&
  price_max=1000&
  in_stock=true&
  page=1&
  limit=25&
  sort=price:asc&
  fields=id,name,price,ratingСтруктура ответаjson{
  "data": [
    {
      "id": 1,
      "name": "Product A",
      "price": 150,
      "rating": 4.5
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 25,
    "total": 150,
    "pages": 6
  },
  "filters": {
    "category": "electronics",
    "price_min": 100,
    "price_max": 1000
  }
}Рекомендации по реализацииИспользуйте стандартные имена параметровДокументируйте доступные фильтры и операторыОграничивайте максимальный размер страницыПредусматривайте значения по умолчаниюОбрабатывайте ошибки валидации параметровВывод: Комбинация GET метода с хорошо структурированными query-параметрами обеспечивает гибкий и стандартизированный подход к получению коллекций данных с поддержкой фильтрации, пагинации и сортировки.