Why consistent formats improve usability in Rest API - See It in Action

Why Consistent Formats Improve Usability in REST APIs

📖 Scenario: You are building a simple REST API for a bookstore. The API returns book information in JSON format. To make it easy for developers to use your API, you want to keep the response format consistent.

🎯 Goal: Build a REST API endpoint that returns book data in a consistent JSON format. You will create the data, set a configuration for the response format, apply the main logic to format the data consistently, and finally output the JSON response.

📋 What You'll Learn

Create a list of dictionaries representing books with exact keys and values

Add a configuration variable to control the response format

Use a function to format each book's data consistently

Print the final JSON response with consistent formatting

💡 Why This Matters

🌍 Real World

APIs are used by many developers and apps. Consistent data formats reduce confusion and bugs.

💼 Career

Understanding how to design and format API responses is important for backend developers and API designers.

1

Create the book data list

Create a list called books with these exact dictionaries: {'id': 1, 'title': '1984', 'author': 'George Orwell'}, {'id': 2, 'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'}, and {'id': 3, 'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald'}.

Rest API

# Create the list called books with the exact dictionaries
# Your code here

Need a hint?

Use a list with three dictionaries exactly as shown.

2

Add a response format configuration

Create a variable called response_format and set it to the string 'json'.

Rest API

books = [
    {'id': 1, 'title': '1984', 'author': 'George Orwell'},
    {'id': 2, 'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'},
    {'id': 3, 'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald'}
]
# Create the variable response_format and set it to 'json'
# Your code here

Need a hint?

Just assign the string 'json' to the variable response_format.

3

Format the book data consistently

Create a function called format_book that takes a book dictionary and returns a new dictionary with keys 'bookId', 'bookTitle', and 'bookAuthor' mapped from book['id'], book['title'], and book['author'] respectively. Then create a list called formatted_books by applying format_book to each book in books.

Rest API

books = [
    {'id': 1, 'title': '1984', 'author': 'George Orwell'},
    {'id': 2, 'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'},
    {'id': 3, 'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald'}
]
response_format = 'json'
# Define the function format_book and create formatted_books list
# Your code here

Need a hint?

Use a function to rename keys and a list comprehension to apply it to all books.

4

Print the JSON response

Import the json module and print the JSON string of formatted_books using json.dumps() with indent=2 for readability.

Rest API

books = [
    {'id': 1, 'title': '1984', 'author': 'George Orwell'},
    {'id': 2, 'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'},
    {'id': 3, 'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald'}
]
response_format = 'json'

def format_book(book):
    return {
        'bookId': book['id'],
        'bookTitle': book['title'],
        'bookAuthor': book['author']
    }

formatted_books = [format_book(book) for book in books]
# Import json and print formatted_books as JSON string with indent=2
# Your code here

Need a hint?

Use json.dumps() with indent=2 to print the list nicely.