Как правильней сделать контроллеры с точки зрения REST?

Question

[Eugenue Cesarevich]

У меня есть сущности Student (студент) и Tutor (преподаватель).
Есть два контроллера соответственно: StudentController и TutorController.

Есть задача. Надо сделать эндпоинт, который будет возвращать студентов, привязанных к конкретному преподавателю. Эндпоинт должен выглядеть вот так: /tutors/{id}/students, потому что в данном случае преподаватель является главным ресурсом.

В каком из контроллеров будет логичней разместить данный эндпоинт?

Плюсы при размещении в StudentController:

1. Это логичней, т.к. запрос относится именно к студентам
   
2. Не придётся дублировать StudentService в TutorController
   
3. Упростит поддержку кода, так как всё, что касается студентов - у студентов
   

2. Плюсы при размещении в TutorController:

1. Вроде бы логичней с точки зрения REST
   
2. Код будет чище (потому что в StudentController по умолчанию путь начинается с /students)
   

Где следует разместить эндпоинт?

Answer 1

[nApoBo3]

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

Comments

[Eugenue Cesarevich]

Звучит логично. Вот только я дефолтно устанавливаю /students в контроллере:

@RequestMapping(value = "/students", produces = MediaType.APPLICATION_JSON_VALUE)

придётся теперь в каждом методе полностью прописывать, потому что некоторые эндпоинты будут с /tutor начинаться.

[nApoBo3]

Зачем начинать их с tutor?
Вариантов масса getStudensByTutor и т.п. Тут нужно смотреть другие эндпоинты как названы и какие варианты получения студентов уже есть.

[Eugenue Cesarevich]

nApoBo3, ну как раз по REST было бы правильней назвать (я имею в виду сам путь запроса, а не название метода) эндпоинт /tutors/{id}/students. Потому что в данном случае students - это подресурс. А все остальные эндопоинты для студента у меня начинаются со /students

[nApoBo3]

Eugenue Cesarevich,
Если бы students были бы подресурсом я бы с вами согласится. Но это не так, это равноправные ресурсы имеющие временные связи между собой. По этому корректнее рассматривать tutor как фильтр к students. Если корректно выстраивать rest то логичнее сделать student/tutor/{id}, хоть это и контр интуитивно. Плюс чистый рест не так часто используют, как мне кажется, чаще это некий микс между rpc и rest, но возможно я ошибаюсь.
В данном случае я исхожу из минимизации зависимостей при разделении.
Можно конечно выделить третий контроллер который отвечает за линки между сущностями, но имхо это оверхед.

[nApoBo3]

Eugenue Cesarevich, можно ещё из tutor возвращать не студентов, а их id, после чего дозапрашивать их в студентах.

[Eugenue Cesarevich]

nApoBo3,

можно ещё из tutor возвращать не студентов, а их id, после чего дозапрашивать их в студентах.

не вполне понимаю, что это даст. Ну собственно id я и возвращаю.

Но это не так, это равноправные ресурсы имеющие временные связи между собой. По этому корректнее рассматривать tutor как фильтр к students. Если корректно выстраивать rest то логичнее сделать student/tutor/{id}

Может быть и так конечно, но это уж слишком контринтуитивно для меня:) Выглядит так, как будто эндпоинт возвращает преподавателей, а не студентов

Answer 2

[Илья]

Третьего не дано?) Ещё один контроллер?

Comments

[Eugenue Cesarevich]

Можно ещё два добавить