Bird
Raised Fist0
Rest APIprogramming~5 mins

HAL format overview in Rest API

Choose your learning style10 modes available
LearnWhyDeepVisualTryChallengeProjectRecallTime

Start learning this pattern below

Jump into concepts and practice - no test required

or
Recommended
Test this pattern10 questions across easy, medium, and hard to know if this pattern is strong
Introduction

HAL helps organize data and links in APIs so computers and people can understand and use them easily.

When building APIs that need to show related information and links clearly.
When you want clients to discover more data by following links automatically.
When you want a simple, standard way to format API responses with data and navigation.
When you want to make your API easier to use and understand without extra documentation.
Syntax
Rest API
{
  "_links": {
    "self": { "href": "/orders/123" },
    "next": { "href": "/orders/124" }
  },
  "property": "value"
}

"_links" holds URLs related to the current data.

Each link has a "href" showing where it points.

Examples
Shows a user with a link to itself.
Rest API
{
  "_links": {
    "self": { "href": "/users/1" }
  },
  "name": "Alice"
}
Shows a book with a link to its author.
Rest API
{
  "_links": {
    "self": { "href": "/books/42" },
    "author": { "href": "/authors/7" }
  },
  "title": "Learn HAL"
}
Sample Program

This is a simple HAL response for a product with links to itself and its reviews.

Rest API
{
  "_links": {
    "self": { "href": "/products/100" },
    "reviews": { "href": "/products/100/reviews" }
  },
  "id": 100,
  "name": "Coffee Mug",
  "price": 12.99
}
OutputSuccess
Important Notes

HAL uses JSON format with special "_links" and optionally "_embedded" sections.

Links help clients navigate the API without guessing URLs.

It keeps API responses consistent and easy to understand.

Summary

HAL organizes API data with links in a simple JSON format.

It helps clients find related information easily.

Using HAL makes APIs more user-friendly and discoverable.

Practice

(1/5)
1. What is the main purpose of the _links section in a HAL formatted REST API response?
easy
A. To define the API version number
B. To store user authentication tokens
C. To list all data fields in the response
D. To provide URLs to related resources for easy navigation

Solution

  1. Step 1: Understand the role of _links in HAL

    The _links section contains URLs pointing to related resources, helping clients navigate the API easily.

  2. Step 2: Compare options with HAL purpose

    Options B, C, and D do not describe navigation or linking related resources, which is the key feature of _links.

  3. Final Answer:

    To provide URLs to related resources for easy navigation -> Option D

  4. Quick Check:

    HAL _links = URLs for related resources [OK]
Hint: Remember: _links always holds related resource URLs [OK]
Common Mistakes:
  • Confusing _links with data fields
  • Thinking _links stores authentication info
  • Assuming _links defines API version
2. Which of the following is the correct way to represent a link to a 'self' resource in HAL JSON?
easy
A. "_links": { "self": { "href": "/orders/123" } }
B. "links": { "self": "/orders/123" }
C. "_links": { "self": "/orders/123" }
D. "_link": { "href": "/orders/123" }

Solution

  1. Step 1: Recall HAL syntax for links

    HAL requires a _links object with named links, each having an href property.

  2. Step 2: Check each option's structure

    "_links": { "self": { "href": "/orders/123" } } correctly uses _links with self containing an object with href. Others miss underscores, use wrong keys, or omit href.

  3. Final Answer:

    "_links": { "self": { "href": "/orders/123" } } -> Option A

  4. Quick Check:

    HAL link = _links + href [OK]
Hint: HAL links always use _links and href keys [OK]
Common Mistakes:
  • Omitting underscore in _links
  • Using string instead of object for link value
  • Missing href property inside link
3. Given the following HAL JSON snippet, what is the URL to access the customer's details? 
{
  "_links": {
    "self": { "href": "/orders/123" },
    "customer": { "href": "/customers/456" }
  },
  "orderNumber": "123"
}
medium
A. /orders/123
B. /customers/456
C. /orders/456
D. /customers/123

Solution

  1. Step 1: Identify the customer link in _links

    The customer key has an href value of "/customers/456" which points to the customer's details URL.

  2. Step 2: Confirm other options

    self points to the order URL "/orders/123". Other options mix order and customer IDs incorrectly.

  3. Final Answer:

    /customers/456 -> Option B

  4. Quick Check:

    Customer link = _links.customer.href = /customers/456 [OK]
Hint: Look inside _links for the named resource URL [OK]
Common Mistakes:
  • Confusing self with customer link
  • Mixing order and customer IDs
  • Ignoring the href property
4. Identify the error in this HAL JSON snippet: 
{
  "_links": {
    "self": "/orders/123",
    "items": [{ "href": "/items/1" }, { "href": "/items/2" }]
  }
}
medium
A. The JSON is correct as is
B. "items" should be a single object, not an array
C. "self" link should be an object with an "href" property
D. "_links" key should be "links" without underscore

Solution

  1. Step 1: Check the structure of the "self" link

    In HAL, each link must be an object with an href property. Here, "self" is a string, which is incorrect.

  2. Step 2: Verify other parts

    "items" is correctly an array of link objects. The _links key must have an underscore. So only "self" link is wrong.

  3. Final Answer:

    "self" link should be an object with an "href" property -> Option C

  4. Quick Check:

    HAL links = objects with href [OK]
Hint: All HAL links must be objects with href keys [OK]
Common Mistakes:
  • Using string instead of object for single links
  • Removing underscore from _links
  • Thinking arrays are not allowed for multiple links
5. You want to design a HAL response for a blog post that includes links to the author and comments. Which JSON structure correctly follows HAL format?
hard
A. { "title": "My Post", "_links": { "self": { "href": "/posts/1" }, "author": { "href": "/users/42" }, "comments": [ { "href": "/comments/100" }, { "href": "/comments/101" } ] } }
B. { "title": "My Post", "links": { "self": "/posts/1", "author": "/users/42", "comments": ["/comments/100", "/comments/101"] } }
C. { "title": "My Post", "_links": { "self": "/posts/1", "author": "/users/42", "comments": "/comments/100,/comments/101" } }
D. { "title": "My Post", "_link": { "self": { "href": "/posts/1" }, "author": { "href": "/users/42" }, "comments": [ { "href": "/comments/100" }, { "href": "/comments/101" } ] } }

Solution

  1. Step 1: Verify the _links key and link objects

    { "title": "My Post", "_links": { "self": { "href": "/posts/1" }, "author": { "href": "/users/42" }, "comments": [ { "href": "/comments/100" }, { "href": "/comments/101" } ] } } correctly uses _links with each link as an object containing href. Multiple comments are an array of link objects.

  2. Step 2: Check other options for errors

    { "title": "My Post", "links": { "self": "/posts/1", "author": "/users/42", "comments": ["/comments/100", "/comments/101"] } } uses "links" without underscore and strings instead of objects. { "title": "My Post", "_links": { "self": "/posts/1", "author": "/users/42", "comments": "/comments/100,/comments/101" } } uses strings instead of objects for links. { "title": "My Post", "_link": { "self": { "href": "/posts/1" }, "author": { "href": "/users/42" }, "comments": [ { "href": "/comments/100" }, { "href": "/comments/101" } ] } } uses incorrect key "_link" instead of "_links".

  3. Final Answer:

    Option A JSON structure correctly follows HAL format -> Option A

  4. Quick Check:

    HAL requires _links with objects having href [OK]
Hint: Use _links with objects and href for all links [OK]
Common Mistakes:
  • Missing underscore in _links
  • Using strings instead of objects for links
  • Wrong key name like _link