REST маршруты именования

Question

У меня есть приложение, которое я создал с использованием Laravel. Я просто пытаюсь понять правильные соглашения об именах для приложения. Поскольку Laravel RESTful, я хочу придерживаться правильных соглашений об именах для REST.

Предпочитаете, что у меня есть ресурс User, у которого есть ресурс . Поэтому я сохраняю внешний ключ user_id в таблице cars. В приложении я хочу обновить детали автомобиля, используя PUT. Итак, как я могу назвать свой URI? Ниже приведены три варианта, которые я рассматриваю. Но я хочу знать, какой когда-то прав:
1. /user/{id}/car/{id}
2. /car/{id}
3. /user/car/{id}

Мой вопрос, я должен включить родительский ресурс (пользователя) в URI, или я могу просто использовать идентификатор автомобиля и обновить его? Я видел в некоторых местах (например, API GitHub), что они используют родительский ресурс перед дочерним ресурсом.

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

Answer 1

Мои два цента:

я бы на

• /car/{id} когда автомобиль идентификатор известен
• /car/?user_id={userId} Для того, чтобы получить все автомобили, принадлежащие пользователю с известным идентификатором.

Если автомобиль всегда принадлежит пользователю (FK не может быть нулевым), вы можете добавить URL-адреса с/user, но было бы сложнее найти автомобиль, если вы не знаете, чья машина это:

• user/{userId}/cars/ Чтобы получить все автомобили, принадлежащие пользователю с известным идентификатором.
• user/{userId}/car/{id} Чтобы получить конкретный автомобиль

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

родитель-ребенок отношение лучше подходит для таких вещей, как компания-отдела (это не имеет никакого смысла искать ИТ-отдела, если не указать компанию, к примеру)

Answer 2

Я бы сказал, что 1 является подходящим случаем, так как «автомобиль» сам по себе не одинок. Это выражает лучшую идею о том, что этот автомобиль находится под этим пользователем, и его можно использовать для проверки, чтобы вы не случайно обновили автомобиль, который не является автомобилем этого пользователя.