Mis on API versioonihaldus
API versioonide haldamine
API versioonihaldus
API versioonihaldus on tava API muudatuste haldamiseks, säilitades tagasiühilduvuse olemasolevatele klientidele.
Versioonimise strateegiad
| Strateegia | Näide | Kirjeldus | |------------|-------|-----------| | URL-tee | /api/v1/users | Versioon URL-tees | | Query parameeter | /api/users?version=1 | Versioon parameetris | | Päis | X-API-Version: 1 | Versioon päises | | Content Type | Accept: application/vnd.api.v1+json | Meediatüübi versioon |
Semantiline versioonihaldus
- Major (v1→v2) — murrangulised muudatused
- Minor (v1.1→v1.2) — uued funktsioonid, tagasiühilduv
- Patch (v1.1.0→v1.1.1) — veaparandused
Parimad tavad
- Dokumenteeri kõik muudatused (changelog)
- Toeta vähemalt 2 versiooni
- Teata deprecation-ist ette
- Kasuta sunset-päiseid
- Paku migratsiooni tööriistu
Millal on uus versioon vajalik
- Väljade või lõpp-punktide eemaldamine
- Vastuse formaadi muutmine
- Parameetrite semantika muutmine
- Autentimise muutmine