In my last post I discussed the start of the next group of guidelines with the use of vocabulary provided goals to curate hypermedia interactions with the service. This exciting idea will allow truly domain driven interaction with your service, while remaining stateless and easy to consume. The next guideline is more of a cautionary tale, and that is the design should be decoupled from the hypermedia format of choice.
When hypermedia is discussed today, I imagine the conversation ventures around the room discussing the different available formats. You’ll hear mention of HAL, JSON API, JSON-LD, Hydra, Siren, and Collection+JSON among others. The pros and cons of each decision are weighed, and eventually a consensus is reached and the team decides to use ‘X’ format. The particular format picked is irrelevant to this discussion, however there is a chance the format picked will include something it shouldn’t; it will include specifications for URL patterns. The problem with this is as the hard won victory of building the hypermedia API and client allows near effortless consumption of the service, formats which specify URL patterns, greatly increase the odds a consumer will cheat and bind to a URL besides the root.
However, this isn’t the only concern for supporting a hypermedia format at specific URL patterns. Suppose you had a requirement to support another format as well? Not a problem, that format can just use these URLs, as hypermedia makes the URLs irrelevant. What happens when the requirement for a 3rd format comes in, and this one also has a specific format it requires? Well things start to break down here, and the service needs to start managing the context between multiple endpoints which are synonymous with each other. This creates a variety of problems you really don’t want to have to deal with, like reduced caching and cache inconsistency as different URLs aren’t cached as the same resource.
The easy, short, and best answer is to simply avoid utilizing the formats which prescribe a URL pattern, if possible leave out those portions of the format which you can, and if that doesn’t work hopefully one of the other fantastic alternatives will provide the right set of attributes to fit your initial use case.