Appunti: API design best practices

Qual è l'importanza della chiarezza nei nomi delle API?

I nomi chiari migliorano la comprensibilità e facilitano l'uso da parte degli sviluppatori.

Principio REST: stateless o stateful?

Stateless. Ogni richiesta deve contenere tutte le informazioni necessarie.

Quali sono i metodi HTTP principali?

- GET - POST - PUT - DELETE

Vero o falso: le API dovrebbero essere versionate sempre.

Vero. Il versionamento aiuta a gestire le modifiche senza rompere la compatibilità.

Cos'è un endpoint in un'API?

Un URL specifico che rappresenta un'operazione o una risorsa nell'API.

Come si gestisce un errore 404?

Restituire un messaggio chiaro che indica che la risorsa non è stata trovata.

Cosa significa 'idempotente' in un metodo API?

Un'operazione può essere eseguita più volte senza cambiare il risultato oltre la prima esecuzione.

Quali sono i formati di risposta comuni per le API?

JSON e XML sono i formati più usati per le risposte delle API.

Qual è il principio DRY?

Don't Repeat Yourself: evitare la duplicazione del codice nelle API.

Come si definisce la documentazione di un'API?

Deve descrivere chiaramente tutte le endpoint, metodi e parametri disponibili.

Qual è l'effetto di una buona gestione delle versioni?

Permette agli sviluppatori di aggiornare senza interrompere gli utenti esistenti.

Cosa deve contenere una risposta API ben formata?

Status, headers e body coerenti con le specifiche richieste.

Fill in the blank: Un'API dovrebbe essere _____ per facilitare l'integrazione.

Facile da usare e navigare.

Cosa significa 'scalabilità' in un design API?

La capacità dell'API di gestire un aumento del carico di lavoro senza degradare le prestazioni.

Qual è il ruolo delle intestazioni HTTP?

Forniscono metadati sulla richiesta o sulla risposta, come tipo di contenuto e autorizzazioni.

Qual è la differenza tra GET e POST?

GET recupera dati, mentre POST invia dati al server per la creazione o l'aggiornamento di risorse.

Che cos'è REST?

REST (Representational State Transfer) è un'architettura per progettare servizi web, basata su HTTP.

JSON vs XML: quale è più leggero?

JSON è più leggero e più facile da leggere rispetto a XML, riducendo il carico di dati.

Qual è il formato comune per le API?

Il formato più comune è JSON, utilizzato per la sua semplicità e compatibilità con JavaScript.

Vero o falso: XML supporta i commenti.

Vero. XML permette l'inserimento di commenti usando <!— commento —>.

Quali metodi HTTP sono più usati?

I metodi più comuni sono GET, POST, PUT, DELETE.

Quale convenzione di denominazione è consigliata per le risorse?

Usare nomi al plurale per le risorse, ad esempio /utenti invece di /utente.

Che cos'è GraphQL?

GraphQL è un linguaggio di query per API, che consente di richiedere solo i dati necessari.

JSON: come rappresentare un array?

Un array in JSON è rappresentato come: [1, 2, 3].

Vero o falso: le API devono restituire sempre lo stesso formato.

Falso. Le API possono supportare più formati, come JSON e XML, in base alle esigenze.

Che significa HATEOAS?

HATEOAS (Hypermedia As The Engine Of Application State) è un principio di REST che fornisce link dinamici nelle risposte.

Qual è la differenza tra API pubbliche e private?

Le API pubbliche sono accessibili a tutti, mentre le API private sono limitate a un utilizzo interno.

Quale è il formato più usato per la documentazione API?

Swagger è uno dei formati più usati per documentare le API.

Cause e effetti: perché usare il versionamento?

Il versionamento permette di mantenere la compatibilità e gestire modifiche senza rompere le integrazioni esistenti.

Che cos'è un endpoint?

Un endpoint è un URL che rappresenta una risorsa specifica in un'API.

Quali sono i tipi di contenuto comuni nelle API?

I tipi di contenuto comuni includono application/json, application/xml, text/html.

Vero o falso: le API dovrebbero essere stateless.

Vero. Le API stateless non mantengono informazioni sullo stato tra le richieste.

Esempio di endpoint RESTful.

/api/utenti/1 per ottenere l'utente con ID 1.

Qual è l'importanza dei codici di stato HTTP?

I codici di stato HTTP comunicano il risultato della richiesta, come 200 per successo o 404 per non trovato.

Cosa rappresenta il termine 'payload'?

Il payload è la parte di una richiesta o risposta contenente i dati reali scambiati.

Che cos'è un webhook?

Un webhook è un metodo per ricevere dati in tempo reale dalle API quando si verifica un evento.

Cos'è l'autenticazione nelle API?

L'autenticazione è il processo di verifica dell'identità di un utente o di un'applicazione che tenta di accedere a un'API.

Qual è la differenza tra autenticazione e autorizzazione?

L'autenticazione verifica chi sei, mentre l'autorizzazione determina cosa puoi fare dopo l'autenticazione.

Vero o falso: HTTPS è importante per la sicurezza delle API.

Vero. HTTPS cripta i dati durante il trasferimento, proteggendo le informazioni sensibili da intercettazioni.

Quali sono i metodi comuni di autenticazione?

- Basic Auth - Token Bearer - OAuth - API Key

Compila il vuoto: OAuth è un protocollo di ___ per autorizzare l'accesso alle API.

OAuth è un protocollo di autorizzazione per autorizzare l'accesso alle API.

Qual è il ruolo dei token JWT nelle API?

I token JWT (JSON Web Tokens) vengono utilizzati per l'autenticazione e l'autorizzazione, consentendo comunicazioni sicure tra client e server.

Cos'è il rate limiting?

Il rate limiting è una pratica di sicurezza che limita il numero di richieste che un utente può effettuare a un'API in un dato periodo di tempo.

Quali sono i rischi delle API non protette?

- Accesso non autorizzato - Furto di dati - Attacchi DDoS

Vero o falso: Le chiavi API devono essere esposte nel codice sorgente.

Falso. Le chiavi API devono essere mantenute segrete e non esposte nel codice sorgente.

Causa → Effetto: Un attacco CSRF può portare a ___

Un attacco CSRF può portare a operazioni non autorizzate eseguite dall'utente sulla tua API.

Qual è l'importanza della validazione dell'input?

La validazione dell'input è cruciale per prevenire attacchi come SQL Injection e XSS, garantendo l'integrità dei dati.

Esempio di autenticazione: Come funziona API Key?

Un client include una chiave API nelle richieste. Il server verifica la chiave e concede l'accesso se valida.

Cos'è il versionamento delle API?

È la pratica di gestire le modifiche alle API nel tempo per garantire compatibilità e stabilità.

Vantaggi del versionamento semantico?

- Chiarezza delle modifiche - Compatibilità garantita - Facilità di integrazione

API v1.0 vs v2.0: differenze?

v1.0 può avere endpoint obsoleti, v2.0 introduce nuove funzionalità senza rompere la compatibilità.

Versionamento: URL o Header?

Utilizzare l'URL è più chiaro per l'utente, mentre l'Header mantiene l'endpoint più pulito.

Vero o falso: le API non devono mai cambiare?

Falso. Le API devono evolversi, ma con cautela per non rompere l'integrazione degli utenti.

Quando deprecate un'API?

Quando è sostituita da una nuova versione o non è più necessaria. Informare gli utenti è cruciale.

Esempio di versionamento in pratica?

Se un'API cambia il formato di risposta, è consigliabile creare un nuovo endpoint, come /api/v2/risorsa.

Qual è l'effetto del versionamento sulle API?

Permette di mantenere compatibilità mentre si introducono nuove funzionalità, evitando rotture per gli sviluppatori.