HTTP No-Vary-Search Header

Typ

Der No-Vary-Search-Header ist ein HTTP-Response-Header, der dem Browser mitteilt, welche URL-Query-Parameter bei Cache-Lookups ignoriert werden sollen, um Cache-Hit-Raten zu erhöhen.

Syntax

Der No-Vary-Search-Header definiert eine Structured Field Dictionary mit Anweisungen, welche Query-Parameter für Cache-Entscheidungen irrelevant sind, oder ob alle Parameter ignoriert werden sollen.

No-Vary-Search: params=("utm_source" "utm_campaign")

Direktiven

Der No-Vary-Search-Header unterstützt mehrere Direktiven zur Kontrolle, welche Query-Parameter Cache-Varianz beeinflussen, kritisch für API-Response-Caching mit Analytics-Parametern.

Beispiele

Die folgenden Beispiele zeigen No-Vary-Search-Konfigurationen für API-Responses mit Tracking-Parametern, CDN-Caching-Strategien und unterschiedliche Ansätze zur Cache-Key-Normalisierung.

HTTP/1.1 200 OK
No-Vary-Search: params=("utm_source" "utm_medium" "utm_campaign" "fbclid")
Cache-Control: public, max-age=3600
Content-Type: application/json

{
  "products": [
    {
      "id": "prod-123",
      "name": "API Gateway License",
      "price": 299.00
    }
  ]
}

HTTP/1.1 200 OK
No-Vary-Search: params, except=("page" "limit" "sort")
Cache-Control: public, max-age=600
Content-Type: application/json

{
  "items": [],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 450
  }
}

HTTP/1.1 200 OK
No-Vary-Search: key-order
Cache-Control: public, max-age=1800
Vary: Accept-Encoding
Content-Type: application/json

{
  "status": "operational",
  "services": {
    "api": "healthy",
    "database": "healthy"
  }
}

Cache-Lookup Flow mit No-Vary-Search

Der Ablauf zeigt, wie Browser und CDNs No-Vary-Search-Anweisungen nutzen, um Cache-Hits für URLs mit unterschiedlichen Tracking-Parametern zu ermöglichen.

@startuml
actor Client
participant Browser
participant "CDN Cache" as CDN
participant "API Server" as API

Client -> Browser: GET /api/products?utm_source=email&utm_campaign=spring
Browser -> CDN: GET /api/products?utm_source=email...
CDN -> API: GET /api/products?utm_source=email...
API --> CDN: 200 OK\nNo-Vary-Search: params=("utm_source" "utm_campaign")\nCache-Control: max-age=3600
CDN -> CDN: Store with normalized cache key\n(ignoring utm_*)
CDN --> Browser: 200 OK
Browser -> Browser: Store response

== Different tracking parameters ==

Client -> Browser: GET /api/products?utm_source=twitter&utm_campaign=summer
Browser -> CDN: GET /api/products?utm_source=twitter...
CDN -> CDN: Normalize cache key\n(ignore utm_source, utm_campaign)
CDN -> CDN: Cache HIT
CDN --> Browser: 200 OK (from cache)
note right: Same cached response,\ntracking params ignored

@enduml

Vorteile für die Systemarchitektur

Spezifikation

Der No-Vary-Search-Header ist in der WICG No-Vary-Search Specification definiert und ermöglicht deklarative Cache-Key-Normalisierung für verbesserte Cache-Effizienz bei URLs mit irrelevanten Query-Parametern.

Weitere Spezifikationen

Vary Header, Cache-Control Header