Validation-based caching in Rest API - Mini Project: Build & Apply

Validation-based caching in a REST API

📖 Scenario: You are building a simple REST API that returns user profile data. To improve performance, you want to add validation-based caching. This means the API will store the last returned data and a validation token (like an ETag). When the client sends a request with the token, the API checks if the data has changed. If not, it returns a 304 Not Modified status instead of the full data.

🎯 Goal: Build a REST API endpoint that returns user data with validation-based caching using ETag headers.

📋 What You'll Learn

Create a dictionary called user_profile with exact keys and values

Create a variable called etag with the exact string value

Write a function called get_user_profile that takes a parameter client_etag and returns a tuple of (status_code, data_or_message)

Print the result of calling get_user_profile with client_etag set to the exact string "abc123"

💡 Why This Matters

🌍 Real World

Validation-based caching is used in web APIs to reduce data transfer and improve speed by sending data only when it changes.

💼 Career

Understanding caching and validation tokens like ETag is important for backend developers working on efficient REST APIs.

1

DATA SETUP: Create the user profile data

Create a dictionary called user_profile with these exact entries: 'id': 101, 'name': 'Alice', 'email': '[e-mail]'

Rest API

# Create the user_profile dictionary with id, name, and email
# Your code here

Hint

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

2

CONFIGURATION: Create the ETag value

Create a variable called etag and set it to the string "abc123"

Rest API

user_profile = {'id': 101, 'name': 'Alice', 'email': '[e-mail]'}
# Create the etag variable with the string "abc123"
# Your code here

Hint

Assign the string "abc123" to the variable etag.

3

CORE LOGIC: Write the get_user_profile function with validation-based caching

Write a function called get_user_profile that takes one parameter client_etag. Inside the function, if client_etag equals the variable etag, return the tuple (304, 'Not Modified'). Otherwise, return the tuple (200, user_profile).

Rest API

user_profile = {'id': 101, 'name': 'Alice', 'email': '[e-mail]'}
etag = "abc123"
# Define the get_user_profile function with client_etag parameter
# Your code here

Hint

Use an if statement to compare client_etag and etag, then return the correct tuple.

4

OUTPUT: Call the function and print the result

Call the function get_user_profile with the argument "abc123" and print the result.

Rest API

user_profile = {'id': 101, 'name': 'Alice', 'email': '[e-mail]'}
etag = "abc123"

def get_user_profile(client_etag):
    if client_etag == etag:
        return (304, 'Not Modified')
    else:
        return (200, user_profile)

# Call get_user_profile with "abc123" and print the result
# Your code here

Hint

Use print(get_user_profile("abc123")) to show the output.

Practice

1. What is the main purpose of validation-based caching in REST APIs?

easy

A. To encrypt data during transmission

B. To speed up the server response by skipping validation

C. To store data permanently on the client side

D. To check if the data has changed before downloading it again

Solution

1. Step 1: Understand validation-based caching concept

   It is used to avoid downloading data again if it has not changed.

2. Step 2: Identify the main purpose

   The main goal is to check if data changed before downloading again to save bandwidth and time.

3. Final Answer:

   To check if the data has changed before downloading it again -> Option D

4. Quick Check:

   Validation-based caching = check data change before download [OK]

Hint: Remember: caching avoids re-downloading unchanged data [OK]

Common Mistakes:

• Thinking caching stores data permanently
• Confusing caching with encryption
• Assuming caching skips validation

2. Which HTTP header does the client send to ask the server if the cached data is still valid?

easy

A. If-Modified-Since

B. ETag

C. If-None-Match

D. Cache-Control

Solution

1. Step 1: Identify client headers for validation

   The client uses headers to tell the server what version it has.

2. Step 2: Match header for ETag validation

   The If-None-Match header is sent with the ETag value to check if data changed.

3. Final Answer:

   If-None-Match -> Option C

4. Quick Check:

   Client asks with If-None-Match header [OK]

Hint: Client sends If-None-Match with ETag to validate cache [OK]

Common Mistakes:

• Confusing If-Modified-Since with If-None-Match
• Using Cache-Control header for validation
• Thinking ETag is sent by client

3. Given this server response to a client request with If-None-Match: "abc123" header:

HTTP/1.1 304 Not Modified
ETag: "abc123"

What does this response mean?

medium

A. The data has changed and new data is sent

B. The data has not changed; client should use cached data

C. The server does not support caching

D. The client must resend the request without ETag

Solution

1. Step 1: Understand HTTP 304 status meaning

   304 means Not Modified, so data is unchanged since last fetch.

2. Step 2: Interpret ETag match

   ETag matches client's value, so server confirms data is still valid.

3. Final Answer:

   The data has not changed; client should use cached data -> Option B

4. Quick Check:

   304 Not Modified = use cached data [OK]

Hint: 304 status means no new data, use cache [OK]

Common Mistakes:

• Thinking 304 means new data sent
• Confusing 304 with 200 OK
• Assuming server rejects caching

4. A client sends a request with header If-None-Match: "xyz789". The server responds with:

HTTP/1.1 200 OK
ETag: "abc123"
{ "data": "new content" }

What is the likely problem in this interaction?

medium

A. The server sent a different ETag, indicating data changed, so 200 OK is correct

B. The server should respond with 304 Not Modified instead of 200 OK

C. The client sent an invalid ETag header

D. The server response is missing the If-None-Match header

Solution

1. Step 1: Compare client and server ETags

   Client sent "xyz789", server responded with "abc123" which is different.

2. Step 2: Understand server response code

   Since ETags differ, data changed, so server correctly sends 200 OK with new data.

3. Final Answer:

   The server sent a different ETag, indicating data changed, so 200 OK is correct -> Option A

4. Quick Check:

   Different ETag means data changed, send 200 OK [OK]

Hint: Different ETag means new data, so 200 OK is correct [OK]

Common Mistakes:

• Expecting 304 when ETags differ
• Thinking client ETag must match server's
• Confusing If-None-Match with If-Match

5. You want to implement validation-based caching in your REST API. Which sequence correctly describes the interaction between client and server?

hard

A. Client sends request with If-None-Match header; server replies 304 if data unchanged or 200 with new data and ETag if changed

B. Server sends ETag in request; client replies 304 if data unchanged or 200 with new data if changed

C. Client sends ETag in response; server sends If-None-Match header to validate cache

D. Server always sends 200 OK with data and never uses ETag

Solution

1. Step 1: Identify correct client-server header roles

   Client sends If-None-Match with ETag to ask if data changed.

2. Step 2: Understand server response logic

   Server replies 304 if data unchanged, or 200 with new data and new ETag if changed.

3. Final Answer:

   Client sends request with If-None-Match header; server replies 304 if data unchanged or 200 with new data and ETag if changed -> Option A

4. Quick Check:

   Client sends If-None-Match; server replies 304 or 200 [OK]

Hint: Client sends If-None-Match; server replies 304 or 200 with ETag [OK]

Common Mistakes:

• Mixing up who sends ETag and If-None-Match
• Thinking server sends If-None-Match header
• Assuming server never sends 304