Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

HAL resolves this by extending JSON to include hypermedia and define the standard so clients can properly identify hypermedia within JSON objects. This is why the SRP HTTP Framework normally sets the Content-Type response header to application/hal+json instead of just application/json. It is important to note that HAL does not redefine JSON. This means clients can navigate and parse HAL content using the same rules as standard JSON.

Reserved Properties

HAL reserves two properties so that clients can interpret hypermedia in a JSON resource object: _links and _embedded. These properties are prefixed with underscores to avoid collision with properties that developers might use in actual static resource content.

This property contains one or more link relationships to the primary resource object. The _links property informs clients that each of the sub-properties are URIs with a relationship to the