REST constraints and principles in Rest API - Mini Project: Build & Apply

Understanding REST Constraints and Principles

📖 Scenario: You are building a simple REST API for a library system. The API should follow REST constraints and principles to manage books data.

🎯 Goal: Learn how to apply REST constraints and principles by creating a basic REST API structure with resources, stateless communication, and proper use of HTTP methods.

📋 What You'll Learn

Create a data structure to hold book information

Define a configuration variable for the API base URL

Implement RESTful routes using HTTP methods for CRUD operations

Display the list of books after operations

💡 Why This Matters

🌍 Real World

REST APIs are used to build web services that allow different software systems to communicate over the internet using standard HTTP methods.

💼 Career

Understanding REST constraints and principles is essential for backend developers, API designers, and full-stack engineers to create scalable and maintainable web services.

1

DATA SETUP: Create the initial books data

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

Rest API

# Create the books dictionary with the given entries
# Your code here

Hint

Use a dictionary with integer keys and dictionaries as values for each book.

2

CONFIGURATION: Define the API base URL

Create a variable called API_BASE_URL and set it to the string "/api/books"

Rest API

books = {
    1: {'title': '1984', 'author': 'George Orwell'},
    2: {'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'},
    3: {'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald'}
}
# Define the API base URL
# Your code here

Hint

Set the base URL string exactly as shown.

3

CORE LOGIC: Implement RESTful routes for GET and POST

Write a function called get_books() that returns the books dictionary, and a function called add_book(book_id, book_info) that adds a new book to books using the given book_id and book_info

Rest API

books = {
    1: {'title': '1984', 'author': 'George Orwell'},
    2: {'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'},
    3: {'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald'}
}
API_BASE_URL = "/api/books"

# Define get_books() and add_book(book_id, book_info) functions
# Your code here

Hint

Use functions to simulate REST GET and POST operations.

4

OUTPUT: Display the books after adding a new book

Call add_book(4, {'title': 'Brave New World', 'author': 'Aldous Huxley'}) and then print the result of get_books()

Rest API

books = {
    1: {'title': '1984', 'author': 'George Orwell'},
    2: {'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'},
    3: {'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald'}
}
API_BASE_URL = "/api/books"

def get_books():
    return books

def add_book(book_id, book_info):
    books[book_id] = book_info

# Add a new book with ID 4 and print all books
# Your code here

Hint

Call the add_book function with the new book details, then print the books dictionary using get_books.

Practice

1. Which of the following is a key constraint of REST that ensures each request from client to server must contain all the information needed to understand and process the request?

easy

A. Cacheability

B. Layered System

C. Statelessness

D. Code on Demand

Solution

1. Step 1: Understand the meaning of statelessness in REST

   Statelessness means the server does not store any client context between requests. Each request must be self-contained.

2. Step 2: Match the constraint to the description

   The description says each request must have all needed info, which matches statelessness.

3. Final Answer:

   Statelessness -> Option C

4. Quick Check:

   Request self-contained = Statelessness [OK]

Hint: Requests must be independent and self-contained [OK]

Common Mistakes:

• Confusing cacheability with statelessness
• Thinking layered system means stateless
• Assuming code on demand is required

2. Which HTTP method is NOT considered safe and idempotent according to REST principles?

easy

A. POST

B. PUT

C. GET

D. DELETE

Solution

1. Step 1: Recall safe and idempotent HTTP methods

   GET, PUT, and DELETE are idempotent; GET is safe. POST is neither safe nor idempotent.

2. Step 2: Identify the method that is not safe and idempotent

   POST changes server state and can create multiple resources, so it is not idempotent or safe.

3. Final Answer:

   POST -> Option A

4. Quick Check:

   POST is not safe or idempotent [OK]

Hint: POST changes data and is not idempotent [OK]

Common Mistakes:

• Thinking PUT is unsafe
• Confusing DELETE as unsafe
• Assuming GET modifies data

3. Given the following REST API response headers, which constraint is being applied?

Cache-Control: max-age=3600
ETag: "abc123"

medium

A. Cacheability

B. Uniform Interface

C. Statelessness

D. Client-Server

Solution

1. Step 1: Analyze the headers Cache-Control and ETag

   Cache-Control and ETag headers control how responses are cached by clients or intermediaries.

2. Step 2: Identify the REST constraint related to caching

   Cacheability means responses can be stored and reused to improve performance.

3. Final Answer:

   Cacheability -> Option A

4. Quick Check:

   Cache headers = Cacheability [OK]

Hint: Cache headers indicate cacheability constraint [OK]

Common Mistakes:

• Confusing cache headers with statelessness
• Thinking uniform interface relates to headers
• Assuming client-server means caching

4. You have a REST API that stores user sessions on the server between requests. Which REST constraint is violated and how can you fix it?

medium

A. Uniform Interface; change URL structure

B. Cacheability; disable caching on responses

C. Layered System; remove intermediaries

D. Statelessness; move session data to client or include in each request

Solution

1. Step 1: Identify the violated constraint

   Storing session data on server between requests breaks statelessness because server keeps client state.

2. Step 2: Suggest a fix to restore statelessness

   Move session info to client (like tokens) or send all needed info in each request.

3. Final Answer:

   Statelessness; move session data to client or include in each request -> Option D

4. Quick Check:

   Server session storage breaks statelessness [OK]

Hint: No server session storage means statelessness [OK]

Common Mistakes:

• Confusing cacheability with session storage
• Thinking layered system relates to sessions
• Trying to fix by changing URLs

5. You want to design a REST API that allows clients to update user profiles partially without sending the entire profile data. Which HTTP method and REST principle best support this requirement?

hard

A. PUT method and Uniform Interface constraint

B. PATCH method and Uniform Interface constraint

C. POST method and Statelessness constraint

D. DELETE method and Cacheability constraint

Solution

1. Step 1: Identify the HTTP method for partial updates

   PATCH is designed for partial updates, unlike PUT which replaces entire resource.

2. Step 2: Connect the method to the REST principle

   Uniform Interface means using standard methods consistently; PATCH fits this principle for partial updates.

3. Final Answer:

   PATCH method and Uniform Interface constraint -> Option B

4. Quick Check:

   Partial update = PATCH + Uniform Interface [OK]

Hint: Partial update uses PATCH and uniform interface [OK]

Common Mistakes:

• Using PUT for partial updates
• Confusing POST with PATCH
• Linking DELETE to updates