How can I handle many-to-many relationships in a RESTful API?

by

Make a separate set of /memberships/ resources.

  1. REST is about making evolvable systems if nothing else. At this moment, you may only care that a given player is on a given team, but at some point in the future, you will want to annotate that relationship with more data: how long they’ve been on that team, who referred them to that team, who their coach is/was while on that team, etc etc.
  2. REST depends on caching for efficiency, which requires some consideration for cache atomicity and invalidation. If you POST a new entity to /teams/3/players/ that list will be invalidated, but you don’t want the alternate URL /players/5/teams/ to remain cached. Yes, different caches will have copies of each list with different ages, and there’s not much we can do about that, but we can at least minimize the confusion for the user POST’ing the update by limiting the number of entities we need to invalidate in their client’s local cache to one and only one at /memberships/98745 (see Helland’s discussion of “alternate indices” in Life beyond Distributed Transactions for a more detailed discussion).
  3. You could implement the above 2 points by simply choosing /players/5/teams or /teams/3/players (but not both). Let’s assume the former. At some point, however, you will want to reserve /players/5/teams/ for a list of current memberships, and yet be able to refer to past memberships somewhere. Make /players/5/memberships/ a list of hyperlinks to /memberships/{id}/ resources, and then you can add /players/5/past_memberships/ when you like, without having to break everyone’s bookmarks for the individual membership resources. This is a general concept; I’m sure you can imagine other similar futures which are more applicable to your specific case.

More Related Contents:

  1. RESTful Authentication
  2. RESTful URL design for search
  3. What are best practices for REST nested resources?
  4. What is the proper REST response code for a valid request but an empty data?
  5. How to version REST URIs
  6. HTTP response code for POST when resource already exists
  7. XDebug and RESTful server using PHPStorm or POSTman
  8. REST Complex/Composite/Nested Resources [closed]
  9. What is the advantage of using REST instead of non-REST HTTP?
  10. What is REST? Slightly confused [closed]
  11. powershell invoke-restmethod multipart/form-data
  12. Transactions across REST microservices?
  13. Designing URI for current logged in user in REST applications
  14. RESTful Services – WSDL Equivalent
  15. Unable to upload zip file through karate framework
  16. What’s the best RESTful method to return total number of items in an object?
  17. Firefox Add-on RESTclient – How to input POST parameters?
  18. Making a PowerShell POST request if a body param starts with ‘@’
  19. Spring 4 RestController JSON: characteristics not acceptable according to the request “accept” headers
  20. Jersey with Struts2 [duplicate]
  21. REST API Authentication
  22. Should I use Singular or Plural name convention for REST resources?
  23. How to download excel (.xls) file from API in postman?
  24. Where can I find jenkins restful api reference? [closed]
  25. Is it correct to return 404 when a REST resource is not found?
  26. When is it appropriate to respond with a HTTP 412 error?
  27. Websocket vs REST when sending data to server
  28. ‘Best’ practice for restful POST response
  29. Swagger UI passing authentication token to API call in header
  30. REST API DESIGN – Getting a resource through REST with different parameters but same url pattern

Leave a Comment