Как правильно спроектировать рест-ресурсы?

Question

[Evgeniy Rybalko]

Добрый день!
Столкнулся с вопросом который сбивает с толку
Допустим у нас есть сервис управления профилем пользователя. Профилю пользователя соответсвует таблица в бд с колонками: имя, фамилия, токен итд.
Если я хочу изменить информацию о пользователе(имя фамилию), я должен обращаться к эндпоинту
/rest/user/
Но если я хочу изменить например токен для входа, я по какому эндпоинту я должен обращаться
/rest/user/security/:id:
Вообще правильно ли я делаю?
В настройках пользователя достаточно много полей и их имеет смысл разбивать на разные блоки с точки зрения ui, но с точки зрения того что я делаю на стороне сервера, мне кажется, что я делаю все не так

Comments

[Ярослав Иванов]

Все очень просто
Берёшь и делаешь. Потом раз 10 исправишь. Когда будешь проектировать новый сервис будешь делать быстрее на старых ошибках.

Answer 1

[xmoonlight]

Тот, кто отвечает за действие - тот и end-point.

[Примеры]

Данные объекта (профиль пользователя): /api/profile/user/<команда(метод)>

Токен доступа:
/api/security/accessToken/<команда(метод)>

Постинг:
/api/content/article/new

Comments

[galliard]

Замечательно, только это не REST.

[xmoonlight]

galliard, ну так проще обращаться к методам.

[galliard]

xmoonlight, возможно. Но автор просил рест-ресурсы. А поскольку вы не упомянули, что это не рест, то он мог бы сделать ложный вывод о том, что так и должны выглядеть рест-ресурсы.

[xmoonlight]

galliard, разница незначительна.

[galliard]

xmoonlight, да, примерно как между поездом и подводной лодкой, и то и другое - средства передвижения.

[xmoonlight]

galliard, откорректировал.
теперь - идеально?

[galliard]

xmoonlight, если честно, не вижу разницы. По моему как было, так и осталось.

[xmoonlight]

galliard, я добавил двоеточие для отделения параметров от метода, этого разве не достаточно?

[galliard]

xmoonlight, нет)

[xmoonlight]

galliard, ок. что не так?

[galliard]

xmoonlight, ну в первую очередь не должно быть никаких <команда(метод)>, только сами сущности, состояния которых изменяется через POST/PUT/PATCH/DELETE запросы.

[xmoonlight]

galliard, тогда значит ты ошибся: у меня было всё верно до этого.

[galliard]

xmoonlight, что у тебя было верно? У тебя как раньше были <команда(метод)>, так и сейчас есть.

[xmoonlight]

galliard, ну, так, это шаблон пути без параметров (общий вид).

[galliard]

xmoonlight, ну вот я и пытаюсь сказать, что такого общего вида быть не должно.

[xmoonlight]

galliard, не нужно придумывать за автора вопроса параметры вызовов.

[galliard]

xmoonlight, так автор сам придумать их не может, поэтому и задал этот вопрос.

Answer 2

[galliard]

Что вам мешает работать с единым объектом пользователя /api/users/:id?
Но если вот прям сильно надо разделить, то /api/users/:id/profile и /api/users/:id/accessToken.