Такие маршруты яв-ся правильными для REST API?

Question

[Gahoy]

Нашел в интернете такую схему для базы данных:


Сделал для него такие маршруты:

// Routes:

// GET:     /api/accounts
// GET:     /api/accounts/:id
// POST:    /api/accounts/:id
// UPDATE:  /api/accounts/:id
// DELETE:  /api/accounts/:id
// GET:     /api/accounts/:id/posts
// GET:     /api/accounts/:id/comments
// GET:     /api/accounts/:id/frends
// POST:    /api/accounts/:id/frends
// DELETE:  /api/accounts/:id/frends

// GET:     /api/posts
// GET:     /api/posts/:id
// POST:    /api/posts/:id
// UPDATE:  /api/posts/:id
// DELETE:  /api/posts/:id
// GET:     /api/posts/:id/comments
// POST:    /api/posts/:id/comments
// UPDATE:  /api/posts/:id/comments
// GET:     /api/posts/:id/comments/:id/likes
// POST:    /api/posts/:id/comments/:id/likes
// DELETE:  /api/posts/:id/comments/:id/likes

И хочу убедиться, что все сделал правильно, то есть для REST API. Такие маршруты яв-ся правильными для REST API ?

ps: или предложите что-то свое... Я только начинаю backend осваивать.

Comments

[Lynn «Кофеман»]

JFYI правильно friends

[Lynn «Кофеман»]

И я не уверен что DELETE: /api/accounts/:id/friends имеет смысл. Может DELETE .../:id/friends/:friend_id ?

[Gahoy]

Lynn «Кофеман», верно, я просто невнимательный.

[сергей кузьмин]

Gahoy а про PUT вы знаете ?
https://translated.turbopages.org/proxy_u/en-ru.ru...

[Gahoy]

сергей кузьмин, знал, но не понимаю все равно когда и почему его использовать, по этму и не использую.

ps: там вышe `pacth` методы использовал (тут не иправленная версия осталась)

[сергей кузьмин]

Gahoy, понять пут это основное! дальше нельзя
в ссылке стак оверфлоу переведенный

[Gahoy]

сергей кузьмин, я кажись понял! put для полного обновления ресурса, а patch только если какое то поле в ресурсе меняется, так ?

[сергей кузьмин]

там же все распис

Разница между PUT и POST состоит в том, что. PUT является идемпотентным: повторное его применение даёт тот же результат, что и при первом применении (то есть у метода нет побочных эффектов), тогда как повторный вызов одного и того же метода. POST может иметь такие эффекты, как например, оформление одного и того же заказа несколько раз. Запрос. POST обычно отправляется через форму HTML и приводит к изменению на сервере.

[Gahoy]

сергей кузьмин, английский плохо знаю.

[сергей кузьмин]

Gahoy,читайте по французки там то же самое

[Gahoy]

сергей кузьмин, POST получется создает пользователя несколько раз (так должно быть), а PUT должен бы просто вернуть 201 статус и все ?

Получается тогда, если нужно всегда что-то создавать, то это POST, а если нужно чтобы это создавалось 1 раз (как аккаунты) то это PUT. Кажись что-то начал понимать, или нет =).

[сергей кузьмин]

Gahoy, https://yandex.ru/search/?text=хабр+Разница+между+...

[Gahoy]

сергей кузьмин, спасибо, это работает.

[Владимир Кочергин]

В маршруте /api/posts/:id/comments/:id/likes часть /posts/:id избыточна. Id комментария и так уникален и указывает на конкретный ресурс, не зависимо от id поста.

Answer 1

[DollyPapper]

В целом да, всё норм

Comments

[Gahoy]

Сейчас (в процессе) появились сомнения по этим маршрутам:

// POST:    /api/accounts/:id/frends/:id
// DELETE:  /api/accounts/:id/frends/:id
//-
// POST:    /api/posts/:id/comments/:id/likes
// DELETE:  /api/posts/:id/comments/:id/likes

Вот добавление лайков к постам у меня получается отдельно, а удаление отдельно, что-то сомневаться начал.

[Uno]

Gahoy, в чем сомнения? лайк можно поставить или удалить. все логично

[Gahoy]

Uno, думал не сделать ли флаг типа 1 ставит а 0 удаляет....

[Василий Банников]

Gahoy, рест в принципе не обязывает всё выражать через состояние.

Установку и удаление лайка можно сделать так:

POST /api/posts/{post-id}/comments/{comment-id}/likes/:set

POST /api/posts/{post-id}/comments/{comment-id}/likes/:unset

Подобную нотацию активно гугл, например, использует.

[Gahoy]

Василий Банников, пробовал так сделать, в принципе норм.

Что заметил:
Параметр стоит в таком случае валидировать, а с `delete & post` не нужно.

[Василий Банников]

Gahoy, почему это не нужно валидировать?

[Gahoy]

Василий Банников, потому что post и delete вместо :set / :unset

[Василий Банников]

Gahoy, не понимаю. Почему вы сравниваете сегмент урла и глагол?
Чем ваш POST лучше моего POST?

По параметрам у нас всё одинаково:
У вас {post-id} и {comment-id} и у меня также.

Может быть вы ошибочно приняли последний сегмент в урле из моего примера за параметр из-за наличия знака двоеточия, которым в ваших примерах показывается параметр?
Я вроде специально у себя заменил двоеточия у параметров на {}, чтобы не вызывать разночтений.

[Gahoy]

Василий Банников, да я думал это парметры. Ну логичнее думаю будет post и delete использовать, так как я удаляю запись и добавляю его. (put и patch пока не вникал еше)

Answer 2

[Сергей delphinpro]

Show accounts  GET:     /api/accounts
Create account POST:    /api/accounts
Show details   GET:     /api/accounts/:id
Update account PUT:     /api/accounts/:id
Delete account DELETE:  /api/accounts/:id

Остальное по аналогии, включая вложенности

Comments

[Gahoy]

Для кажой сущности (то есть таблицы в БД) так сделать ? Это разве правильно будет...