Vad är API-versionering
Hantering av API-versioner
API-versionering
API-versionering är praxis att hantera API-ändringar samtidigt som bakåtkompatibilitet upprätthålls för befintliga klienter.
Versionsstrategier
| Strategi | Exempel | Beskrivning | |----------|---------|-------------| | URL-sökväg | /api/v1/users | Version i URL-sökväg | | Query-parameter | /api/users?version=1 | Version i parameter | | Header | X-API-Version: 1 | Version i header | | Content Type | Accept: application/vnd.api.v1+json | Mediatypsversion |
Semantisk versionering
- Major (v1→v2) — brytande ändringar
- Minor (v1.1→v1.2) — nya funktioner, bakåtkompatibel
- Patch (v1.1.0→v1.1.1) — buggfixar
Bästa praxis
- Dokumentera alla ändringar (changelog)
- Stöd minst 2 versioner
- Meddela deprecation i förväg
- Använd sunset-headers
- Tillhandahåll migrationsverktyg
När en ny version behövs
- Borttagning av fält eller endpoints
- Ändring av svarsformat
- Ändring av parametersemantik
- Ändring av autentisering