Versioning API
Politique de compatibilité pour l’API REST Orbit.
Base
La première API publique stable utilisera un préfixe majeur, par exemple /v1.
Les changements compatibles restent dans la même version majeure.
Breaking changes
Un breaking change requiert une nouvelle version majeure ou un mécanisme de négociation clairement documenté.
Dépréciation
Toute dépréciation publique doit fournir :
- date d’annonce ;
- remplacement ;
- exemples de migration ;
- date cible de retrait ;
- métriques d’usage si disponibles.
Idempotence
Les endpoints d’écriture critiques doivent accepter une clé d’idempotence.
Pagination
Utiliser des curseurs opaques plutôt que des offsets lorsque l’ordre peut changer.
Was this page helpful?