Response headers (Cache-Control, ETag) in Rest API

Introduction

Response headers like Cache-Control and ETag help browsers and servers work together to save time and data by reusing stored information.

When you want to make your website load faster by telling browsers to reuse saved pages.

When you want to check if a file on the server has changed before sending it again.

When you want to reduce the amount of data sent over the internet to save bandwidth.

When you want to improve user experience by loading pages quickly.

When you want to control how long browsers keep a copy of your content.

Syntax

Rest API

Cache-Control: max-age=seconds, no-cache, no-store, public, private
ETag: "unique-identifier"

Cache-Control tells the browser how long to keep a copy of the response.

ETag is a unique tag that changes when the content changes, helping browsers check if they need to update.

Examples

This tells the browser to keep the response for 1 hour (3600 seconds) before asking again.

Rest API

Cache-Control: max-age=3600

This tells the browser to always check with the server before using the cached response.

Rest API

Cache-Control: no-cache

This is a unique tag that the server sends. The browser can send it back to check if the content changed.

Rest API

ETag: "abc123xyz"

This means the response is for a single user only, kept for 10 minutes, with a version tag to check changes.

Rest API

Cache-Control: private, max-age=600
ETag: "v1.0-2024"

Sample Program

This small web server sends data with Cache-Control and ETag headers. If the client already has the same ETag, it returns a 304 status to save data.

Rest API

from flask import Flask, request, make_response

app = Flask(__name__)

@app.route('/data')
def data():
    content = 'Hello, this is some data.'
    etag = 'abc123xyz'

    # Check if client sent ETag
    if_none_match = request.headers.get('If-None-Match')
    if if_none_match == etag:
        # Content not changed
        response = make_response('', 304)  # 304 Not Modified
    else:
        # Send content with headers
        response = make_response(content)
        response.headers['Cache-Control'] = 'max-age=60'
        response.headers['ETag'] = etag
    return response

if __name__ == '__main__':
    app.run(debug=True)

Important Notes

Always use ETag with Cache-Control to make caching smarter.

Setting Cache-Control: no-store means the browser should never save the response.

304 status means 'Not Modified' and tells the browser to use its saved copy.

Summary

Cache-Control tells browsers how long to keep data.

ETag helps check if data changed to avoid sending it again.

Using these headers makes websites faster and saves data.

Practice

1. What is the main purpose of the Cache-Control header in an HTTP response?

easy

A. To indicate the response content type

B. To encrypt the response data for security

C. To specify the server's IP address

D. To tell browsers how long to keep the response data

Solution

1. Step 1: Understand the role of Cache-Control

   The Cache-Control header instructs browsers and caches how long they can store the response data before requesting it again.

2. Step 2: Compare options with Cache-Control purpose

   Only To tell browsers how long to keep the response data correctly describes this behavior. Other options describe unrelated functions.

3. Final Answer:

   To tell browsers how long to keep the response data -> Option D

4. Quick Check:

   Cache-Control = Duration for caching [OK]

Hint: Cache-Control controls data storage time in browsers [OK]

Common Mistakes:

• Confusing Cache-Control with security headers
• Thinking Cache-Control sets content type
• Assuming Cache-Control reveals server info

2. Which of the following is the correct syntax to set a Cache-Control header to cache content for 3600 seconds?

easy

A. "Cache-Control: max-age=3600"

B. "Cache-Control: timeout=3600"

C. "Cache-Control: expires=3600"

D. "Cache-Control: duration=3600"

Solution

1. Step 1: Recall Cache-Control max-age syntax

   The correct way to specify caching time in seconds is using max-age=seconds.

2. Step 2: Check each option's correctness

   Only "Cache-Control: max-age=3600" uses max-age=3600, which is valid. Others use invalid directives.

3. Final Answer:

   "Cache-Control: max-age=3600" -> Option A

4. Quick Check:

   max-age sets cache time [OK]

Hint: Use max-age to set cache time in seconds [OK]

Common Mistakes:

• Using 'timeout' instead of 'max-age'
• Confusing Cache-Control with Expires header syntax
• Using unsupported directives like 'duration'

3. Given this HTTP response header snippet:

Cache-Control: max-age=0, must-revalidate
ETag: "abc123"

What happens when the browser sends a request with header If-None-Match: "abc123"?

medium

A. Server returns 304 Not Modified if content unchanged

B. Server returns full content ignoring ETag

C. Server returns 500 Internal Server Error

D. Server always returns 200 OK with new ETag

Solution

1. Step 1: Understand ETag and If-None-Match interaction

   The ETag header is a unique identifier for the content version. The browser sends If-None-Match with the ETag value to check if content changed.

2. Step 2: Interpret Cache-Control and server response

   With max-age=0 and must-revalidate, the browser asks server to validate content. If ETag matches, server responds with 304 Not Modified, saving bandwidth.

3. Final Answer:

   Server returns 304 Not Modified if content unchanged -> Option A

4. Quick Check:

   ETag + If-None-Match = 304 if unchanged [OK]

Hint: ETag + If-None-Match = 304 Not Modified if same [OK]

Common Mistakes:

• Assuming server always sends full content
• Confusing 304 with error codes
• Ignoring Cache-Control directives

4. A developer sets the response header as Cache-Control: max-age=abc. What is the likely result?

medium

A. The browser caches the response for 'abc' seconds

B. The server returns a syntax error

C. The browser ignores the Cache-Control header and does not cache

D. The browser caches the response indefinitely

Solution

1. Step 1: Analyze max-age value validity

   The max-age directive requires a numeric value in seconds. 'abc' is invalid.

2. Step 2: Understand browser behavior on invalid Cache-Control

   Browsers typically ignore invalid Cache-Control headers and treat the response as non-cacheable.

3. Final Answer:

   The browser ignores the Cache-Control header and does not cache -> Option C

4. Quick Check:

   Invalid max-age causes no caching [OK]

Hint: max-age must be a number, else ignored [OK]

Common Mistakes:

• Thinking server returns error for header syntax
• Assuming browser caches with invalid value
• Confusing max-age with other headers

5. You want to optimize a REST API to reduce bandwidth by sending full data only when it changes. Which combination of headers should you use in the response?

hard

A. Cache-Control: max-age=0 and no ETag

B. Cache-Control: no-cache and ETag with unique value

C. Cache-Control: no-store and no ETag

D. Cache-Control: max-age=3600 and no ETag

Solution

1. Step 1: Identify headers that enable conditional requests

   ETag provides a unique identifier for content versions, allowing clients to ask if content changed.

2. Step 2: Understand Cache-Control no-cache directive

   no-cache forces the browser to validate with the server before using cached data, ensuring fresh content without unnecessary full data transfer.

3. Step 3: Evaluate other options

   Options without ETag cannot validate changes efficiently; no-store disables caching; max-age=0 without ETag disables validation.

4. Final Answer:

   Cache-Control: no-cache and ETag with unique value -> Option B

5. Quick Check:

   no-cache + ETag = bandwidth saving [OK]

Hint: Use no-cache with ETag for efficient validation [OK]

Common Mistakes:

• Omitting ETag disables change detection
• Using no-store disables caching entirely
• Assuming max-age alone reduces bandwidth