Le chemin d’accès (path) est un élément fondamental de vos API : il identifie la ressource ciblée et permet de router correctement les requêtes.

Nous expliquons ici comment structurer vos URI pour garantir clarté, cohérence et simplicité d’utilisation pour les consommateurs.

- Règles PAT -

PAT‑01 : Le premier élément d’un chemin PEUT être un descripteur de domaine.

PAT‑02 : La version de l’API DOIT être dans le chemin, en première position.

PAT‑03 : Seul le numéro de version majeure DEVRAIT faire partie du chemin.

PAT‑04 : Le numéro de version DEVRAIT être préfixé par la lettre v.

PAT‑05 : Les informations de version NE DOIVENT PAS être dans la query string ou les en-têtes.

PAT‑06 : Le chemin DOIT uniquement contenir des noms au pluriel (et identifiants), sans verbe.

PAT‑07 : La hiérarchie de l’URI NE DEVRAIT PAS dépasser 6 niveaux.