HAL format overview in Rest API - Mini Project: Build & Apply

HAL Format Overview with REST API

📖 Scenario: You are building a simple REST API that returns data using the HAL (Hypertext Application Language) format. HAL helps clients navigate your API by including links and embedded resources in the response.

🎯 Goal: Create a basic HAL formatted JSON response for a resource with links and embedded data.

📋 What You'll Learn

Create a dictionary representing a resource with properties

Add a _links section with a self link

Add an _embedded section with a related resource

Print the final HAL formatted JSON response

💡 Why This Matters

🌍 Real World

HAL format is used in REST APIs to help clients discover related resources easily by following links and embedded data.

💼 Career

Understanding HAL helps backend developers design APIs that are easy to navigate and integrate, improving client-server communication.

1

Create the main resource dictionary

Create a dictionary called resource with these exact entries: "id": 1, "name": "Example Resource"

Rest API

# Create the main resource dictionary
# Your code here

Need a hint?

Use curly braces {} to create a dictionary with keys and values.

2

Add the _links section with a self link

Add a key "_links" to the resource dictionary. Set its value to a dictionary with a "self" key that has a dictionary value with "href": "/resources/1"

Rest API

resource = {"id": 1, "name": "Example Resource"}
# Add the _links section with a self link
# Your code here

Need a hint?

Use resource["_links"] = {...} to add the links section.

3

Add the _embedded section with a related resource

Add a key "_embedded" to the resource dictionary. Set its value to a dictionary with a key "related" that contains a list with one dictionary: {"id": 2, "name": "Related Resource"}

Rest API

resource = {"id": 1, "name": "Example Resource"}
resource["_links"] = {"self": {"href": "/resources/1"}}
# Add the _embedded section with a related resource
# Your code here

Need a hint?

Use a list inside the "related" key to hold embedded resources.

4

Print the HAL formatted JSON response

Import the json module and print the resource dictionary as a JSON string using json.dumps(resource)

Rest API

resource = {"id": 1, "name": "Example Resource"}
resource["_links"] = {"self": {"href": "/resources/1"}}
resource["_embedded"] = {"related": [{"id": 2, "name": "Related Resource"}]}
# Import json and print the resource as JSON
# Your code here

Need a hint?

Use import json and print(json.dumps(resource)) to show the JSON string.