Лучшая практика для разработки REST API для подмножеств ресурса

Question

Учитывая структуру URL, как это:

GET   /user/giftcards/:id 

Возвращая список со всем моим GiftCard:

GET   /user/giftcards 

И здесь приходит на мои вопросы, что лучше всего подходит для структуры URL, если я также хочу вернуть подразделы подарочных карт, например, полученные или отправленные?

Сегодня я делаю это (но я знаю, что его неправильно, так как URL должен представляет существительное/ресурс (здесь: GiftCard)

GET   /user/giftcardsreceived 
GET   /user/giftcardssent 

Как я вижу это есть два «лучше» решения:

GET   /user/giftcards/received 
GET   /user/giftcards/sent 

или

GET   /user/giftcards?filter=received 
GET   /user/giftcards?filter=sent 

Im склоняется к запросу парам раствора с фильтрацией, так как с другой стороны может потенциально конфликт с GET на основе id.

Любые указания в правильном направлении.

Answer 1

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

Ознакомьтесь с презентацией Брайана Муллоя на странице api design. Это хорошее место для начала, как любое

Answer 2

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

Следующая ссылка может дать вам дополнительные подсказки:

• Проектирование Web API - https://templth.wordpress.com/2014/12/15/designing-a-web-api/. Смотрите раздел «Фильтрация данные

Надеется, что это помогает вам, Тьерри