Design d’API RESTful
Les règles essentielles
- Les règles REQ -
- Les règles REQ -
La qualité des requêtes est un élément central pour la robustesse et la cohérence de vos API.
Dans ce chapitre, nous détaillons les bonnes pratiques pour structurer vos requêtes, gérer les paramètres et standardiser les comportements pour des intégrations plus fiables.
- Règles REQ -
REQ‑01 : Pour les requêtes POST, PATCH, PUT, les attributs DOIVENT être dans le corps (body).
REQ‑02 : La requête DOIT accepter le contenu JSON.
REQ‑03 : La requête DEVRAIT accepter le contenu XML.
REQ‑04 : La description du format de la requête envoyée DOIT être faite en utilisant l’en-tête Content‑Type.
REQ‑05 : Le format de réponse attendu DOIT être spécifié explicitement dans l’en-tête Accept.
REQ‑06 : Les en-têtes de requête DOIVENT suivre les noms conventionnels.
REQ‑07 : Les en-têtes non conventionnels DOIVENT être préfixés par x-.