template-webapp/docs/API.md

Spécification API

Décrit les conventions d’API côté backend et les règles de compatibilité.

---

Légende des zones

• <A REMPLIR - PROJET> (exemple: à personnaliser — a supprimer) : à compléter par toi selon le projet.
• <A COMPLETER PAR AGENT> : à compléter par un agent spécialisé backend.

---

1. Versioning

• Stratégie (URL, header, autre) :
• Politique de dépréciation :

2. Authentification

• Méthode (JWT = jeton, session, OAuth = délégation d’accès) :
• Durée de session / refresh :

3. Conventions HTTP

• Codes d’erreurs :
• Idempotence (appel sans effet si répété) :
• Pagination :
• Tri/filtre :

4. Formats

• Format JSON :
• Dates / timezone :
• Naming (camelCase, snake_case) :

5. Contrats

• Erreurs : contracts/errors.md
• Pagination : contracts/pagination.md
• Modèle de données : contracts/data_model.md

---

Exemple (a supprimer)

• Versioning : /api/v1.
• Dates : ISO-8601 en UTC.
• Erreurs : { "error": { "code": "VALIDATION_ERROR" } }.