API
Cosa sono
API sta per Application Programming Interface.
È l’insieme delle funzioni e dei metodi che possono essere richiamati da altri programmi per manipolare e visualizzare dati del programma che fornisce le API.
Best Practises
- Usare i JSON: sono più veloci, più supportati e vengono usati quasi ovunque.
- Nomi anziché verbi negli endpoint: questo perché già i metodi
classici dell’HTTP hanno i verbi.
- SI: localhost:8000/posts
- NO: localhost:8000/getPosts
- I metodi che tipicamente si utilizzano sono:
- GET: ritorna dati
- POST: inserisce nuovi dati
- PUT: aggiorna dati già esistenti
- DELETE: elimina dati
-
Quando trattiamo di collezioni usiamo nomi al plurale: i metodi classici dell’HTTP hanno già i verbi.
SI: localhost:8000/posts/123
NO: localhost:8000/post/123
-
Usa i soliti classici codici di errore web (100, 200…)
-
Innesta gli endpoint se occorre quando vuoi mostrare relazioni.
: ES: localhost/posts/postId/comments
Il nesting deve essere ⇐ 3.
- Permetti di filtrare, ordinare e paginare le risposte.
Vedi anche REST