Возвращать полные записи или только идентификатор и заголовок для каждой записи из REST / конечной точки записей?

Question

У меня есть следующий API REST:

• GET / notes
• GET / notes /: id

note 
{
   id, title, body 
}

Было бы приемлемо вернуть только {id, title} из /notes конечной точки? Я не хочу таскать тела заметок, когда пользователь запрашивает список заметок. Я бы предпочел вернуть полную заметку {id, title, body}, когда пользователь делает выбор и запрашивает конкретную заметку, используя /notes/id конечную точку.

Возможно, следует ввести /note_list конечную точку для этой задачи?

Answer 1

Я предполагаю, что RESTful возвращает полные ресурсы при использовании конечной точки /notes, но мне это кажется странным. Зачем кому-то нужны целые данные таблицы? В 99 процентах вам нужны только ссылочные данные (идентификатор и имя) при запросе списка записей.

Во всяком случае, после некоторых исследований я нашел следующие варианты:

1. Частичный ответ в стиле из google api
2. Ввести в конечную точку /notes специальный параметр, чтобы отметить, что ответ будет частичным, например, /notes/header

Подход 1 вероятно, перерасход для моего специализированного API, я мог бы go с подходом 2.