Perché la progettazione dell'API è importante
Un'API ben progettata è un prodotto in sé. Affecta l'esperienza dello sviluppatore, la velocità di integrazione e la manutenibilità a lungo termine. Ecco i principi che seguiamo a DevFlow.
Principi di progettazione dell'URL
Nomi dei risorse
Usa nomi, non verbi. Il metodo HTTP specifica l'azione.
# Buono
GET /api/v1/utenti
POST /api/v1/utenti
GET /api/v1/utenti/:id
# Cattivo
GET /api/v1/utenti/get
POST /api/v1/utenti/creaFormato di risposta coerente
Ogni punto finale dell'API dovrebbe restituire un formato coerente, in modo che i consumatori sappiano cosa aspettarsi.
{
"status": "success",
"data": { "id": "utente-123", "nome": "John Doe" },
"paginazione": { "pagina": 2, "limite": 20, "totale": 150 }
}Codici di stato HTTP
| Codice | Utilizzo |
|---|---|
| 200 | GET, PUT, PATCH riusciti |
| 201 | POST riuscito (risorsa creata) |
| 204 | DELETE riuscito (nessun contenuto) |
| 400 | Validazione fallita |
| 401 | Autenticazione richiesta |
| 403 | Permessi insufficienti |
| 404 | Risorsa non trovata |
| 429 | Limite di rate eccessivo |
Modelli di paginazione
# Basato sul cursore (consigliato per grandi insiemi di dati)
GET /api/v1/posti?cursor=eyJpZCI6MTAwfQ&limite=20
# Basato sull'offset (più semplice, buono per piccoli insiemi di dati)
GET /api/v1/posti?page=3&limite=20Conclusione
Una buona progettazione dell'API è un investimento che rende dividendi durante tutto il ciclo di vita del prodotto. Segui le convenzioni, sii coerente e documenta tutto.