Каков предпочтительный шаблон URL REST для запроса объекта, который является частью коллекции?

Question

У нас есть REST API с коллекцией каналов. При запросе канала я должен использовать конечную точку сбора каналов или конечную точку объекта канала?

/channels/{id}/     // this?
/channel/{id}/      // or this?

Я хочу, чтобы это работало с backbone.js как можно более плавным, когда дело доходит до атрибута URL модели магистрали.

Answer 1

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

Призвание:

 GET /channel -> List of channels
 GET /channel/{id} -> Gets a channel
 POST /channel -> Creates a new channel
 PUT /channel/{id} -> Updates an existing channel

и так далее. Тем не менее, для Backbone это не имеет значения, поскольку вы можете настроить поведение URL по своему усмотрению.

Answer 2

В какой-то момент это действительно просто предпочтение. Некоторые люди утверждают, что определение REST apis всегда должно быть во множественном числе. Главным образом меня всегда раздражает, когда /channel является списком, поэтому я естественно стремлюсь рассматривать все во множественном числе /channels. Что является обратным от того, что они говорят вам делать в дизайне стола: относиться ко всему как к единственному. В конце концов, просто быть последовательным сделает многих людей, использующих ваш apis, счастливыми.

Answer 3

/ в конце не должно иметь значения для предпочтения (слишком запутанно для пользователей, если это так!), И хотя вы можете использовать единственное или множественное число по своему выбору, будьте единообразны во всем приложении и сделайте физические лица дети из коллекции . Думайте о коллекции как о каталоге людей.