If Level 3 HATEOS is an aspirational goal for your service, then resources are probably pretty important to you.

Note that the the /items/{item_id} resource uses a URL Template pattern to emphasize to your clients that they need to substitute a value.

This README is often a good place to put common service information such as:

  • ETags
  • Authentication
  • Rate Throttling
  • etc.