Convenzioni URL, metodi, errori («GET», «POST», «PUT», «DELETE»)

Convenzioni URL, metodi, errori («GET», «POST», «PUT», «DELETE»)

Un'API affidabile e comprensibile inizia con le regole di calcolo delle interfacce. Seguiamo le migliori pratiche di REST. in modo che ogni sviluppatore sappia cosa aspettarsi: la struttura URL è logica, i metodi corrispondono all'azione e gli errori sono facilmente interpretabili.

Questo riduce la soglia di accesso, semplifica le integrazioni e consente di scalare il sistema senza caos.

Convenzioni URL e metodi HTTP

Metodo	Assegnazione	Richiesta di esempio
'GET'	Ricezione risorsa	' GET/users/42 '
'POST'	Crea una nuova risorsa	'POST/users'
'PUT'	Aggiornamento completo della risorsa	'PUT/users/42'
'PATCH'	Aggiornamento parziale della risorsa (opz.)	`PATCH /users/42`
'DELETE'	Rimuovi risorsa	'DELETE/users/42'

Utilizzabili in molteplici («/users », «/devices», «/games »)
Le entità annidate sono descritte come gerarchie ('/users/42/sessions ')
Tutte le richieste vengono effettuate tramite HTTPS

Standard di gestione degli errori

Codice	Valore	Messaggio di esempio
'400'	Richiesta non valida	'Missing richired field: email'
'401'	Non autorizzato	'Invalid token or expired section'
'403'	Accesso negato	'Access denied to resource'
'404'	Impossibile trovare	'User with ID 42 not found'
'409'	Conflitto (ad esempio duplicazione)	'Email already in use'
'422'	Errore di convalida	'Field' agè must be a number '
'500'	Errore interno del server	'Unexpected excession, contact support'

Struttura di risposta all'errore:

• ```json
• {
• “ error “ : {
• “ code “ : 400,
• “ message “ : “ Missing required field: email “ ,
• “ details “ : {...}
• }
• }
• ```

Vantaggi per gli sviluppatori

Comprensione rapida della logica API senza troppa documentazione
Approccio unificato a tutti i moduli e entità
Facile debug e loging con codici e formati standard
Compatibilità con SDK/Swagger, Postman
Supporto, test e CD semplificati

Dove è particolarmente importante

Piattaforme API aperte o partner
Progetti con più team di sviluppo
Architettura di microservizi o approccio API-first
Sistemi con più entità e interazioni

Le convenzioni unificate rendono l'API affidabile, comprensibile e conveniente. Seguiamo le migliori pratiche REST. in modo che ogni integrazione avvenga rapidamente, senza equivoci e con la massima prevedibilità.