Design d’API RESTful
Les règles essentielles
- Les règles ADD -
- Les règles ADD -
Ce dernier chapitre rassemble des bonnes pratiques transversales qui complètent les règles abordées précédemment.
Il s’agit de conseils qui permettent de raffiner la qualité globale de vos API et d’assurer leur pérennité dans un environnement technique en constante évolution.
- Règles ADD -
ADD‑01 : Une API exposée DEVRAIT être compatible CORS.
ADD‑02 : Les valeurs de date DOIVENT suivre la norme ISO 8601.
ADD‑03 : L’UpperCamelCase (ou PascalCase) DEVRAIT être adopté pour le nom des attributs.
ADD‑04 : Le style kebab-case DEVRAIT être adopté pour les URI.
ADD‑05 : La longueur des URI/URL DEVRAIT être limitée.
ADD‑06 : Les endpoints DOIVENT être conçus selon le principe de responsabilité unique.
- Pour aller plus loin -
Norme ISO 8601 (ADD-02) : https://www.iso.org/iso-8601-date-and-time-format.html
RFC 7230 (ADD-05) : https://www.rfc-editor.org/rfc/rfc7230