Как указать REST API для включения дополнительных данных для данного ресурса

Как указать REST API для включения дополнительных данных для данного ресурса

проверка правописания; что касается REST, вы не запрашиваете данный ресурс с дополнительными данными, вы запрашиваете другой ресурс. Нет особой причины, по которой этому новому ресурсу нужен идентификатор, связанный с существующим.

Каковы лучшие практики здесь?

Подумайте, как бы вы поступили с веб-сайтом.

URI будет создан путем представления пользователю формы с элементами ввода, позволяющими клиенту указать значения в строке запроса. Другими словами, форма играет роль шаблона URI.

Таким образом, чтобы дать потребителю дополнительный контроль, вы должны включить в форму новый элемент управления вводом — это может быть произвольное текстовое поле или что-то вроде элемента управления списком, который перечисляет конкретные возможные значения.

Какой параметр запроса следует добавить в соответствии с отраслевыми стандартами

Есть несколько возможностей.

Вы можете просмотреть список связей IANA, чтобы увидеть если есть близкое совпадение. Технически отношения ссылок не являются параметрами запроса. Но что этот список делает, так это сопоставляет правописание с семантикой, что вам действительно нужно: есть ли общее понимание foobar, которое вы можете использовать для своих нужд.

Другой вариант — поискать на таких ресурсах, как schema.org, где опять же есть много интересных сопоставлений между орфографией и семантикой.

Я случайно узнал, что EventStore API использует embed с другими значениями, чтобы позволить клиенту указать, что он хочет получить доступ к ресурсам с более подробной информацией; но, насколько мне известно, этот выбор был произвольным, не основанным на каком-либо реальном «отраслевом стандарте».

как насчет этого, например:

// здесь ваш код

$результат; // ваша переменная, которую будет отправлять ваш API

$пользователь = Пользователь::все(); // ваш дополнительный запрос будет включен в ваш ответный API

// пример дополнительных данных все пользовательские данные $result['user'] = $user;