Ceci est une ancienne révision du document !
APIs web
REST
REST (Representational State Transfer) ou RESTful permet de construire des api (Application Programming Interface ou Web Service), pour permettre la communication entre applications.
REST est fondé sur un ensemble de conventions et de bonnes pratiques à respecter et non sur une technologie à part entière. L’architecture REST utilise les spécifications du protocole HTTP, plutôt que de réinventer une surcouche (comme le font SOAP ou XML-RPC par exemple).
Principes REST
- l’URI comme identifiant des ressources
- les verbes HTTP comme identifiant des opérations
- les réponses HTTP comme représentation des ressources
- les liens comme relation entre ressources
- un paramètre comme jeton d’authentification
1- URI
REST se base sur les URI pour identifier une ressource. Une API doit définir ses URI (et donc ses URL) de manière précise, en tenant compte des contraintes de lisibilité de REST, en prenant en compte la hiérarchie des ressources et la sémantique des URL :
Exemples de construction d’URL avec RESTful :
Liste des clients
NOK : https://myapi.com/client OK : https://myapi.com/clients
Liste des clients avec filtre et tri
NOK : https://myapi.com/clients/filtre/caen/tri/asc OK : https://myapi.com/clients?filtre=caen&tri=asc
Affichage d'un client
NOK : https://myapi.com/clients/87 OK : https://myapi.com/clients/87
Commandes d'un client
NOK : https://myapi.com/clients/commands/87 OK : https://myapi.com/clients/87/commands
Une Commande d'un client
NOK : https://myapi.com/clients/commands/87/1568 OK : https://myapi.com/clients/87/commands/1568
2 - Méthodes HTTP
Utilisation des verbes HTTP existants (méthodes) plutôt que d’inclure l’opération dans l’URI de la ressource.
| Action | Méthode (verbe) |
|---|---|
| Créer (create) | POST |
| Afficher (read) | GET |
| Mettre à jour (update) | PUT |
| Supprimer (delete) | DELETE |
Créer un client
NOK : GET https://myapi.com/clients/create OK : POST https://myapi.com/clients
Afficher un client
NOK : GET https://myapi.com/clients/display/87 OK : GET https://myapi.com/clients/87
Mettre à jour un client
NOK : POST https://myapi.com/clients/update/87 OK : PUT https://myapi.com/clients/87
Supprimer un client
NOK : GET https://myapi.com/clients/delete/87 OK : DELETE https://myapi.com/clients/87
jcheron