WedX - журнал о программировании и компьютерных науках

REST: фильтрация основного ресурса по свойствам связанного ресурса.

Я ищу некоторые рекомендации/советы/входные данные по концепции фильтрации ресурсов при вызове REST API. Допустим, у меня есть пользователи и сообщения, и пользователь создает сообщение. Если я хочу получить все сообщения, у меня может быть следующий маршрут:

GET /api/posts

Теперь, если бы я хотел получить все сообщения, созданные после определенной даты, я мог бы добавить такой параметр фильтра, как

GET /api/posts?created_after=2017-09-01

Однако, допустим, я хочу получить все сообщения Пользователей, созданные после определенной даты. Это правильный формат?

GET /api/posts?user.created_after=2017-09-01

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

api rest filter group-by relationship
26.09.2017

Ответы:


1

Не существует объективного «правильного» пути. Если использование user.created_after логически имеет смысл в контексте вашего API, то в этом нет ничего плохого.

26.09.2017

2

Лично я бы не стал использовать user.created_after.

Я бы предпочел один из следующих вариантов:

Вариант I: /api/posts/users/{userid}?created_after=2017-09-01

Вариант II: /api/posts/?user={userid}&created_after=2017-09-01

Причина проста: мне кажется неправильным создавать динамические параметры запроса. Вместо этого вы можете комбинировать параметры запроса (вариант II) или даже определить более конкретный ресурс (вариант I).

Что касается разбивки на страницы: стандартный подход примерно такой: помимо параметров фильтра вы определяете следующие параметры: page и pageSize. При построении запроса клиент укажет что-то вроде page=2&pageSize=25&orderBy=creationDate. Важно отметить, что сервер должен всегда проверять параметры и потенциально может игнорировать или переопределять неправильные параметры (например, страница не существует или слишком большой размер страницы может не возвращать ошибку, а вместо этого возвращать разумный вывод. Это действительно зависит от вашего бизнеса. кейс)

26.09.2017
  • В начале нет доступного идентификатора пользователя, поэтому: /api/users/?created_after=2017-09-01 вернет всех пользователей, созданных после этой даты. После этого вы можете запрашивать сообщения, в которых идентификатор пользователя находится в этом списке: /api/posts/?user=[{user id}] или цикл, вызывающий /api/posts/?user={userid} 20.07.2021
    • Новые материалы
    Объяснение документов 02: BERT
    BERT представил двухступенчатую структуру обучения: предварительное обучение и тонкая настройка. Во время предварительного обучения модель обучается на неразмеченных данных с помощью..
    Как проанализировать работу вашего классификатора?
    Не всегда просто знать, какие показатели использовать С развитием глубокого обучения все больше и больше людей учатся обучать свой первый классификатор. Но как только вы закончите..
    Работа с цепями Маркова, часть 4 (Машинное обучение)
    Нелинейные цепи Маркова с агрегатором и их приложения (arXiv) Автор : Бар Лайт Аннотация: Изучаются свойства подкласса случайных процессов, называемых дискретными нелинейными цепями Маркова..
    Crazy Laravel Livewire упростил мне создание электронной коммерции (панель администратора и API) [Часть 3]
    Как вы сегодня, ребята? В этой части мы создадим CRUD для данных о продукте. Думаю, в этой части я не буду слишком много делиться теорией, но чаще буду делиться своим кодом. Потому что..
    Использование машинного обучения и Python для классификации 1000 сезонов новичков MLB Hitter
    Чему может научиться машина, глядя на сезоны новичков 1000 игроков MLB? Это то, что исследует это приложение. В этом процессе мы будем использовать неконтролируемое обучение, чтобы..
    Учебные заметки: создание моего первого пакета Node.js
    Это мои обучающие заметки, когда я научился создавать свой самый первый пакет Node.js, распространяемый через npm. Оглавление Глоссарий I. Новый пакет 1.1 советы по инициализации..
    Забудьте о Matplotlib: улучшите визуализацию данных с помощью умопомрачительных функций Seaborn!
    Примечание. Эта запись в блоге предполагает базовое знакомство с Python и концепциями анализа данных. Привет, энтузиасты данных! Добро пожаловать в мой блог, где я расскажу о невероятных..
    Для любых предложений по сайту: [email protected]