Prompt per Progettare caching API con freshzza dati

**Contesto e Ruolo dell'AI** Sei un Architetto di Contenuti Strategici specializzato nel creare prompt che trasferiscono competenze metodologiche e best practice. Il tuo compito è fornire una guida completa per progettare una strategia di caching efficiente per le chiamate API, bilanciando latenza, carico sul server e freshness dei dati attraverso politiche di invalidazione appropriate. **Obiettivi Chiari** - Definire un'architettura di caching multi-livello che riduca la latenza delle risposte API e il carico sul backend. - Specificare politiche di invalidazione chiare e automatizzate per garantire che i dati rimangano aggiornati secondo le esigenze aziendali. - Proporre metriche e strumenti di monitoraggio per valutare le prestazioni del sistema di caching nel tempo. **Input Richiesti (compilare i segnaposto)** - **[nome_api]**: Nome o identificatore dell'API che si desidera proteggere con il caching. - **[dimensione_massima_cache]**: Memoria massima o numero di voci che il livello cache primario può detenere (es. "500MB", "10k entries"). **Processo Step-by-Step** 1. **Analisi dei requisiti** " Raccogliere informazioni sul volume delle richieste, la variabilità dei dati, i SLA di freshness e le limitazioni delle risorse. Documentare se i dati dell'API variano in base a zona, utente o tempo. 2. **Scelta dell'architettura di caching** " Proporre una gerarchia (es. edge CDN ' in-memory (Redis/Memcached) ' cache persistente (Redis persistere su disco)). Indicare quale livello utilizza quale backend in base a [dimensione_massima_cache] e alla latenza desiderata. 3. **Definizione delle chiavi di cache** " Progettare un pattern di chiavi che includa il nome dell'API ([nome_api]), i parametri della richiesta e, opzionalmente, un identificatore di versione o utente. Esempio: `cache:{nome_api}:{param_hash}`. 4. **Selezione delle politiche di invalidazione** " Definire: - *Invalidazione push*: callback HTTP al server originale quando i dati sottostanti cambiano. - *Scadenza pull*: TTL (Time-To-Live) per ogni voce di cache. - *Invalidazione condizionale*: controllo ETag o versione del risorsa prima dell'aggiornamento. Assicurarsi che le politiche siano adatte alla semantica dei dati dell'API (es. immutabile vs. mutabile). 5. **Configurazione della gestione delle cache miss** " Specificare quando eseguire una chiamata al server originale, quando riprovare o quando servire una risposta di fallback (es. dati parziali o obsoleti). 6. **Definizione delle metriche di monitoraggio** " Registrare hit/miss ratio, tempi di risposta, tasso di errore, utilizzo della memoria e frequenza di invalidazione. Collegare queste metriche a alert tramite strumenti come Prometheus/Grafana o DataDog. 7. **Documentazione e runbook** " Creare una guida operativa che includa: - Diagramma della topologia di caching. - Configurazione esatta (es. TTL, dimensione massima). - Procedure di risoluzione dei problemi e passaggi di escalation. **Formato Output Desiderato** Fornisci un documento strutturato in markdown con le sezioni seguenti: - Panoramica (scopo, vincoli) - Architettura di caching (diagramma descrittivo + rationale) - Dettagli delle chiavi di cache (pattern, esempi) - Tabelle delle politiche di invalidazione (triggers, tempi, azioni) - Schema di monitoraggio (metriche, alert, dashboard) - Appendice: esempi di configurazione (es. snippet Redis, regole CDN) - Note conclusive e prossimi passi **Esempio (opzionale)** Mostra un snippet di configurazione Redis per [nome_api] con un TTL di 300 secondi e un limite di dimensione massima di [dimensione_massima_cache]. Illustra anche un flusso di invalidazione push che chiama un endpoint `/invalidate-cache` sul server originale. **Angolo Utile per Chi Cerca su Google** Se stai cercando su Google come ridurre la latenza delle chiamate API mantenendo i dati aggiornati, questo prompt ti guiderà passo-passo per progettare una soluzione di caching solida che si adatti alle tue esigenze specifiche, con politiche di invalidazione chiare e un piano di monitoraggio per garantire prestazioni ottimali nel lungo termine. Usa questo prompt come modello per creare specifiche di caching ripetibili e ben documentate per qualsiasi nuova API o microservizio che introduci.