Link relations in responses in Rest API - Mini Project: Build & Apply

Link relations in REST API responses

📖 Scenario: You are building a simple REST API that returns information about books. To help clients navigate your API easily, you want to include link relations in the JSON responses. These links tell clients where to find related resources, like the author's details or the list of all books.

🎯 Goal: Create a JSON response for a book that includes _links with link relations for self, author, and all_books. This helps API users understand how to get more information.

📋 What You'll Learn

Create a dictionary called book with keys id, title, and author_id with exact values

Create a variable called base_url with the string "https://api.example.com/books"

Add a key _links to the book dictionary with nested dictionaries for self, author, and all_books containing exact URLs

Print the book dictionary as a JSON string with indentation

💡 Why This Matters

🌍 Real World

APIs often include link relations in responses to guide clients to related data easily, improving usability and discoverability.

💼 Career

Understanding how to add link relations is important for backend developers working with REST APIs to create clear, navigable responses.

1

Create the initial book data

Create a dictionary called book with these exact entries: 'id': 101, 'title': 'Learn REST APIs', and 'author_id': 5.

Rest API

# Create the book dictionary with id, title, and author_id
# Your code here

Need a hint?

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

2

Add the base URL variable

Create a variable called base_url and set it to the string "https://api.example.com/books".

Rest API

book = {'id': 101, 'title': 'Learn REST APIs', 'author_id': 5}
# Create the base_url variable with the API base URL
# Your code here

Need a hint?

Use quotes to create a string and assign it to base_url.

3

Add link relations to the book dictionary

Add a key _links to the book dictionary. It should be a dictionary with keys self, author, and all_books. Each key should map to a dictionary with a key href and the exact URLs: self is f"{base_url}/{book['id']}", author is f"https://api.example.com/authors/{book['author_id']}", and all_books is base_url.

Rest API

book = {'id': 101, 'title': 'Learn REST APIs', 'author_id': 5}
base_url = "https://api.example.com/books"
# Add the _links dictionary with self, author, and all_books URLs
# Your code here

Need a hint?

Use f-strings to build URLs using base_url and values from book.

4

Print the JSON response

Import the json module and print the book dictionary as a JSON string with indentation of 2 spaces using json.dumps().

Rest API

book = {'id': 101, 'title': 'Learn REST APIs', 'author_id': 5}
base_url = "https://api.example.com/books"
book['_links'] = {
    'self': {'href': f"{base_url}/{book['id']}"},
    'author': {'href': f"https://api.example.com/authors/{book['author_id']}"},
    'all_books': {'href': base_url}
}
# Import json and print the book dictionary as JSON with indent=2
# Your code here

Need a hint?

Use import json at the top, then print(json.dumps(book, indent=2)) to show the JSON nicely.