Kui API areneb aktiivselt, on oluline säilitada ühilduvus versioonide vahel ja vältida olukordi, kus üks muudatus katkestab kümneid klientide integratsioone. Rakendame täieliku versiooni lepinguid, mis võimaldab teil kontrollida muudatusi ja sujuvalt ajakohastada APIs ilma ohtu kasutajatele.
See on kriitiline mikroservice arhitektuur, B2B integratsioonid, ja avatud API tooteid, kus erinevad kliendid kasutavad erinevaid versioone liideste.
Mida me versioneerime
| Objekt | Kirjeldus |
|---|---|
| OpenAPI spetsifikatsioonid | Säilita dokumentatsiooni ja lepingu iga versioon |
| Tulemusnäitaja | Lisage URL-i versioonid („/v1/“, „/v2/“), salvestage tagantjärele ühilduvus |
| Lepingud (pakt, Dredd) | Kliendi ja serveri vastastikuse mõju tingimuste kindlaksmääramine |
| Andmemudelid | Taotluse ja vastuste struktuuri muutuste jälgimine |
Kuidas me rakendame
Mitme API versiooni paralleelne toetamine
Selgesõnaline versioneerimine URL-ides, päistes või parameetrites
Iga lepingu versiooni automaatne testimine (Pakt, Postimees, Jest, Dredd)
Versiooninõuded Gitis või CI/CD kaudu
Iga muudatuse dokumentatsioon ja changelog klientidele
Eelised
Integratsiooni stabiilsuse tagamine
Võime vabastada uusi funktsioone ilma klientide „murdmise“ ohuta
Lihtsustada rännet versioonide vahel
Selge muutuste ajalugu ja lepingu kontroll
Väliste ja sisemise arengu meeskondade läbipaistvus
Kus eriti oluline
Mitmest sõltuvusest sõltuv mikroservice arhitektuur
Avalikud või B2B API platvormid
Pikaajaliste lepingutega finants- ja maksesüsteemid
Mobiilirakendused, mis sõltuvad stabiilsest API
Lepingute muutmine on etteaimatavuse ja usalduse alus APIs. Rakendame protsesse, mis võimaldavad teil muuta ja arendada API valuta, säilitades samal ajal ühilduvuse ja läbipaistvuse kõigile osapooltele.