CODEWITHSUNDEEP
restrestful-architecturerestful-url
Romper
Romper

Reputation: 2259

REST and subcollections

I have resource collection users and each user can have a filter, so another resource collection is filters.

So, to retrieve filters we have this url

/users/:id/filters

How should be url to retrieve a filter by id?

Upvotes: 1

Views: 1495

Answers (3)

Romper
Romper

Reputation: 2259

  1. Assign all resources a canonical URI at the root (e.g. /companies/{id} and /employees/{id}).
  2. If a resource cannot exist without another, it should be represented as its sub-resource

The URLs are shorter, easier to remember and not many parameters are required.

https://stackoverflow.com/a/19285843/7527624

https://stackoverflow.com/a/32820784/7527624

Upvotes: 1

Lan
Lan

Reputation: 1204

Are the filters first-class entities or owned by a user? For example, can a filter belong to two users or put in another way, is a filter created then assigned to one or more individuals?

If the filters are properties of the users (one filter to one user, one user to one or more filters) /users/:id/filters/:id makes a lot of sense. If the filters are themselves distinct objects that are related to users (one or more users per filter) then either API (perhaps even both) may make sense depending on how the user is expected to consume the API. If they only care about filters, /filter/:id makes sense, if they only care about users' filters /users/:id/filters/:id is appropriate, or if their needs vary between the two, having both is a sensible solution.

Upvotes: 2

Abie
Abie

Reputation: 644

/users/:id/filters/:id makes more sense, as the query is to retrieve a specific filter corresponding to a specific user.

Upvotes: 0

Related Questions