Tutoriel API RESTful
Dans le développement web moderne, les API RESTful sont devenues le moyen standard pour les applications de communiquer entre elles.
REST (Representational State Transfer) est un style d'architecture logicielle proposé par Dr. Roy Fielding en 2000.
REST définit un ensemble de contraintes et de principes pour créer des services web évolutifs et faiblement couplés.
Une API RESTful est une API conçue en suivant le style architectural REST. Elle exploite les caractéristiques du protocole HTTP pour localiser des ressources via des URL et utilise les méthodes HTTP (GET, POST, etc.) pour décrire les opérations, permettant l'interaction entre le client et le serveur.
Qui devrait lire ce tutoriel ?
Que vous soyez un développeur front-end qui doit interagir avec des API back-end, ou un développeur back-end qui doit concevoir des interfaces API, maîtriser les API RESTful est une compétence essentielle.
Caractéristiques de l'API RESTful ?
Caractéristiques clés:
- Sans état: chaque requête contient toutes les informations nécessaires à son traitement
- Interface uniforme: utilise des méthodes HTTP standard pour les opérations
- Orienté ressources: tout est abstrait sous forme de ressources
- Cachable: les réponses doivent indiquer explicitement si elles peuvent être mises en cache
Principes fondamentaux d'une API RESTful
1. Ressources et URI
En REST, tout est abstrait sous forme de ressource, et chaque ressource possède un identifiant unique (URI).
Directives de conception d'URI:
- Utilisez des noms plutôt que des verbes pour représenter les ressources
- Utilisez le pluriel pour les collections
- Utilisez des lettres minuscules et des traits d'union (-)
- Évitez les extensions de fichier
Exemple:
/users # 用户集合 /users/123 # ID为123的用户 /users/123/orders # 用户123的订单集合
2. Utilisation des méthodes HTTP
Les API RESTful exploitent pleinement la sémantique des méthodes HTTP :
| Méthode HTTP | Description | Idempotence | Sécurité |
|---|---|---|---|
| GET | Récupérer une ressource | Oui | Oui |
| POST | Créer une ressource | non | non |
| PUT | Mettre à jour complètement une ressource | Oui | non |
| PATCH | Mettre à jour partiellement une ressource | non | non |
| DELETE | Supprimer une ressource | Oui | non |
3. Absence d'état
Chaque requête doit contenir toutes les informations nécessaires à son traitement, et le serveur ne stocke pas l'état du client. Cela rend l'API facile à mettre à l'échelle et à équilibrer la charge.
4. Formes de représentation
Les ressources peuvent avoir plusieurs formes de représentation (par exemple, JSON, XML), et le client spécifie le format souhaité via l'en-tête Accept.
Autres extensions