Hva er API-versjonering
API-versjonshåndtering
API-versjonering
API-versjonering er praksis for å administrere API-endringer samtidig som bakoverkompatibilitet opprettholdes for eksisterende klienter.
Versjonsstrategier
| Strategi | Eksempel | Beskrivelse | |----------|----------|-------------| | URL-sti | /api/v1/users | Versjon i URL-sti | | Query-parameter | /api/users?version=1 | Versjon i parameter | | Header | X-API-Version: 1 | Versjon i header | | Content Type | Accept: application/vnd.api.v1+json | Mediatypeversjon |
Semantisk versjonering
- Major (v1→v2) — brytende endringer
- Minor (v1.1→v1.2) — nye funksjoner, bakoverkompatibel
- Patch (v1.1.0→v1.1.1) — feilrettinger
Beste praksis
- Dokumenter alle endringer (changelog)
- Støtt minst 2 versjoner
- Varsle deprecation på forhånd
- Bruk sunset-headers
- Tilby migrasjonsverktøy
Når en ny versjon trengs
- Fjerning av felt eller endpoints
- Endring av svarformat
- Endring av parametersemantikk
- Endring av autentisering