generated from gilles/template-webapp
43 lines
1.3 KiB
Markdown
43 lines
1.3 KiB
Markdown
# 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) : <A COMPLETER PAR AGENT>
|
||
- Politique de dépréciation : <A COMPLETER PAR AGENT>
|
||
|
||
## 2. Authentification
|
||
- Méthode (JWT = jeton, session, OAuth = délégation d’accès) : <A COMPLETER PAR AGENT>
|
||
- Durée de session / refresh : <A COMPLETER PAR AGENT>
|
||
|
||
## 3. Conventions HTTP
|
||
- Codes d’erreurs : <A COMPLETER PAR AGENT>
|
||
- Idempotence (appel sans effet si répété) : <A COMPLETER PAR AGENT>
|
||
- Pagination : <A COMPLETER PAR AGENT>
|
||
- Tri/filtre : <A COMPLETER PAR AGENT>
|
||
|
||
## 4. Formats
|
||
- Format JSON : <A COMPLETER PAR AGENT>
|
||
- Dates / timezone : <A COMPLETER PAR AGENT>
|
||
- Naming (camelCase, snake_case) : <A COMPLETER PAR AGENT>
|
||
|
||
## 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" } }`.
|