Я пытаюсь правильно назвать API в случае, когда мне нужно получить более одной версии ресурса. Позвольте мне привести пример:
GET: /api/workers/
Я предполагаю, что выше вернутся все работники со всеми свойствами (идентификатор, имя, день рождения, национальность и т. Д.)
Однако я могу создать образ системы, в которой мне нужно:
- Менее подробные данные (просто рабочие
'id'
и 'name'
) для заполнения поля со списком.
- Более подробные данные, например, все работники вместе с их количеством детей или следующим запланированным отпуском.
Я провел исследование, но не нашел ни одного блога / статьи по вышеуказанной проблеме.
То, что я думаю сделать, это что-то вроде:
GET: /api/workers/basic
GET: /api/workres/detailed
но у меня есть чувство, что такой подход не подходит, так как можно представить больше вариантов «базовых» данных (просто id
и name
или id
, name
и age
) и еще больше вариантов «подробно» (с children
, с holidays
, с salary
, со всеми возможными связанными данными и т. д.)